diff --git a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml index 8c466452..3516f709 100644 --- a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +++ b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml @@ -1350,7 +1350,7 @@ components: description: > Specifies the unique identification of an account as assigned by the account servicer. - oneOf: + anyOf: - properties: IBAN: allOf: @@ -1385,7 +1385,7 @@ components: type: object description: | Sets of elements to identify a name of the identification scheme. - oneOf: + anyOf: - properties: Cd: allOf: @@ -1433,16 +1433,8 @@ components: ActiveCurrencyAndAmount_SimpleType: title: ActiveCurrencyAndAmount_SimpleType type: string - description: | - NOTE: This regex doesn't seem correct given it's xsd definition. - - - - - - - - pattern: ^(?=[\d\-\.\,]{1,18}$)([\d\-\,\.]{1,5})?$ + 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 @@ -1484,8 +1476,9 @@ components: ActiveOrHistoricCurrencyAndAmount_SimpleType: title: ActiveOrHistoricCurrencyAndAmount_SimpleType type: string - pattern: ^(?=[\d\-\.\,]{1,18}$)([\d\-\,\.]{1,5})?$ 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 @@ -1520,7 +1513,7 @@ components: type: object description: | Choice of formats for the type of address. - oneOf: + anyOf: - properties: Cd: allOf: @@ -1574,8 +1567,9 @@ components: type: string description: | Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%. - pattern: ^(?=[\d\-\.\,]{1,11}$)([\d\-\,\.]{1,10})?$ 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 @@ -1833,7 +1827,7 @@ components: description: | Specifies the nature, or use of the account. type: object - oneOf: + anyOf: - properties: Cd: allOf: @@ -1860,7 +1854,7 @@ components: Contains details about high level purpose of the mandate based on a set of pre-defined categories. type: object - oneOf: + anyOf: - properties: Cd: allOf: @@ -1918,7 +1912,7 @@ components: ChargeType3Choice Specifies the type of charge. type: object - oneOf: + anyOf: - properties: Cd: allOf: @@ -2015,7 +2009,7 @@ components: description: | Specifies the clearing system identification. type: object - oneOf: + anyOf: - properties: Cd: allOf: @@ -2622,7 +2616,7 @@ components: description: | Cryptographically signed terms type: object - oneOf: + anyOf: - properties: IlpV4PrepPacket: allOf: @@ -2752,7 +2746,6 @@ components: description: | Specifies a hexadecimal string with a length of 32 characters. type: string - pattern: ^([0-9A-F][0-9A-F]){32}$ example: 1234567890ABCDEF1234567890ABCDEF Exact4AlphaNumericText: title: Exact4AlphaNumericText @@ -2985,7 +2978,7 @@ components: type: object description: | Specifies the name of the identification scheme. - oneOf: + anyOf: - properties: Cd: allOf: @@ -3180,8 +3173,14 @@ components: Set of characteristics shared by all individual transactions included in the message. + CdtTrfTxInf: + allOf: + - $ref: "#/components/schemas/CreditTransferTransaction68" + - description: | + Credit Transfer Transaction Information required: - GrpHdr + - CdtTrfTxInf example: GrpHdr: MsgId: 12345 @@ -3875,17 +3874,11 @@ components: - $ref: "#/components/schemas/PaymentTypeInformation28" - description: | Payment Type Information - CdtTrfTxInf: - allOf: - - $ref: "#/components/schemas/CreditTransferTransaction68" - - description: | - Credit Transfer Transaction Information required: - MsgId - CreDtTm - NbOfTxs - SttlmInf - - CdtTrfTxInf example: MsgId: 12345 CreDtTm: "2020-01-01T00:00:00Z" @@ -3909,29 +3902,6 @@ components: 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 - CdtrAgtAcct: - Id: - IBAN: BE71096123456769 - Ccy: EUR - RmtInf: - Ustrd: Test GroupHeader120: title: GroupHeader120 description: > @@ -4025,17 +3995,11 @@ components: - $ref: "#/components/schemas/SettlementInstruction15" - description: | Settlement Information - CdtTrfTxInf: - allOf: - - $ref: "#/components/schemas/CreditTransferTransaction67" - - description: | - Credit Transfer Transaction Information required: - MsgId - CreDtTm - NbOfTxs - SttlmInf - - CdtTrfTxInf example: MsgId: 12345 CreDtTm: "2020-01-01T00:00:00Z" @@ -4050,26 +4014,6 @@ components: Nm: John Doe SttlmAcctSvcr: BICFI: 123 - CdtTrfTxInf: - PmtId: - InstrId: 123 - EndToEndId: 123 - PmtTpInf: - InstrPrty: NORM - InstdAmt: - Amt: 123 - Ccy: EUR - ChrgBr: SLEV - CdtrAgt: - FinInstnId: - BICFI: 123 - Cdtr: - Nm: John Doe - CdtrAcct: - Id: - IBAN: 123 - RmtInf: - Ustrd: Test IBAN2007Identifier: title: IBAN2007Identifier description: > @@ -4081,8 +4025,8 @@ components: International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard. type: string - pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ example: FR1420041010050500013M02606 + pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ ISODate: title: ISODate description: > @@ -4346,7 +4290,7 @@ components: description: > Specifies the local instrument, as published in an external local instrument code list or as a proprietary code. - oneOf: + anyOf: - properties: Cd: allOf: @@ -4492,8 +4436,8 @@ components: Number: title: Number type: string - pattern: ^[\d\-\.\,]{1,18}$ example: 256 + pattern: ^(?!0\d)\d{1,18}$ OrganisationIdentification29: title: OrganisationIdentification29 description: | @@ -4586,7 +4530,7 @@ components: - description: | Proprietary Name of the identification scheme, in a free text form. - oneOf: + anyOf: - properties: Cd: {} - properties: @@ -4714,7 +4658,7 @@ components: description: | Nature or use of the account. type: object - oneOf: + anyOf: - properties: OrgId: allOf: @@ -4747,7 +4691,7 @@ components: description: | Identification of a person, an organisation or a financial institution. type: object - oneOf: + anyOf: - properties: Pty: allOf: @@ -4795,7 +4739,7 @@ components: description: | NOTE: Unsure on the description. type: object - oneOf: + anyOf: - properties: OrgId: allOf: @@ -5231,8 +5175,9 @@ components: PercentageRate: title: PercentageRate type: string - pattern: ^(?=[\d\-\.\,]{1,11}$)([\d\-\,\.]{1,10})?$ 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: | @@ -5296,7 +5241,7 @@ components: description: | Sets of elements to identify a name of the identification scheme. type: object - oneOf: + anyOf: - properties: Cd: allOf: @@ -5539,7 +5484,7 @@ components: description: | Specifies the type of the proxy account. type: object - oneOf: + anyOf: - properties: Cd: allOf: @@ -5578,7 +5523,7 @@ components: chain. type: object - oneOf: + anyOf: - properties: Cd: allOf: @@ -5701,7 +5646,7 @@ components: description: | Details about a service level. type: object - oneOf: + anyOf: - properties: Cd: allOf: @@ -5792,7 +5737,7 @@ components: description: | Specifies the reason for the status. type: object - oneOf: + anyOf: - properties: Cd: allOf: @@ -6485,8 +6430,14 @@ components: Set of characteristics shared by all individual transactions included in the message. + CdtTrfTxInf: + allOf: + - $ref: "#/components/schemas/CreditTransferTransaction67" + - description: | + Credit Transfer Transaction Information required: - GrpHdr + - CdtTrfTxInf example: GrpHdr: MsgId: 123456789 @@ -6553,15 +6504,16 @@ components: UUIDv4Identifier: title: UUIDv4Identifier type: string - pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$ 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}$ VerificationReason1Choice: title: VerificationReason1Choice type: object description: | Choice of format for the verification reason. Only one, between the coded and the proprietary, can be chosen. - oneOf: + anyOf: - properties: Cd: allOf: @@ -6680,5 +6632,5 @@ components: hexBinary: title: hexBinary type: string - pattern: ^(0x|0X)?[a-fA-F0-9]+$ example: 4660 + pattern: ^[A-Za-z0-9-_]+[=]{0,2}$ diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml index 13864be7..c9d1546f 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml @@ -3,7 +3,7 @@ type: object description: > Specifies the unique identification of an account as assigned by the account servicer. -oneOf: +anyOf: - properties: IBAN: allOf: @@ -29,4 +29,4 @@ oneOf: required: - Othr example: - IBAN: BE71096123456769 \ No newline at end of file + IBAN: BE71096123456769 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml index b2f05186..a67d6575 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml @@ -2,7 +2,7 @@ title: AccountSchemeName1Choice type: object description: | Sets of elements to identify a name of the identification scheme. -oneOf: +anyOf: - properties: Cd: allOf: @@ -24,4 +24,4 @@ oneOf: required: - Prtry example: - Cd: 1111 \ No newline at end of file + Cd: 1111 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount_SimpleType.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount_SimpleType.yaml index 6e0f4f27..545ff922 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount_SimpleType.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount_SimpleType.yaml @@ -1,13 +1,4 @@ title: ActiveCurrencyAndAmount_SimpleType type: string -description: | - NOTE: This regex doesn't seem correct given it's xsd definition. - - - - - - - -pattern: ^(?=[\d\-\.\,]{1,18}$)([\d\-\,\.]{1,5})?$ +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 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml index b14ec0cf..beafa413 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml @@ -1,4 +1,4 @@ title: ActiveOrHistoricCurrencyAndAmount_SimpleType type: string -pattern: ^(?=[\d\-\.\,]{1,18}$)([\d\-\,\.]{1,5})?$ 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})$ diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml index c0692c54..a73e7530 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml @@ -2,7 +2,7 @@ title: AddressType3Choice type: object description: | Choice of formats for the type of address. -oneOf: +anyOf: - properties: Cd: allOf: @@ -24,4 +24,4 @@ oneOf: required: - Prtry example: - Cd: ADDR \ No newline at end of file + Cd: ADDR diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BaseOneRate.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BaseOneRate.yaml index 3b00c267..d0b4e8fa 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BaseOneRate.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BaseOneRate.yaml @@ -2,5 +2,5 @@ title: BaseOneRate type: string description: | Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%. -pattern: ^(?=[\d\-\.\,]{1,11}$)([\d\-\,\.]{1,10})?$ 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})$ diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml index 9e4f9f9a..34ff2531 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml @@ -2,7 +2,7 @@ title: CashAccountType2Choice description: | Specifies the nature, or use of the account. type: object -oneOf: +anyOf: - properties: Cd: allOf: @@ -24,4 +24,4 @@ oneOf: required: - Prtry example: - Cd: CACC \ No newline at end of file + Cd: CACC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml index 43eadae2..4c2b059b 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml @@ -3,7 +3,7 @@ description: > Contains details about high level purpose of the mandate based on a set of pre-defined categories. type: object -oneOf: +anyOf: - properties: Cd: allOf: @@ -25,4 +25,4 @@ oneOf: required: - Prtry example: - Cd: CASH \ No newline at end of file + Cd: CASH diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml index 4fd12f57..3adc01d2 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml @@ -4,7 +4,7 @@ description: > Specifies the type of charge. type: object -oneOf: +anyOf: - properties: Cd: allOf: @@ -26,4 +26,4 @@ oneOf: required: - Prtry example: - Cd: CASH \ No newline at end of file + Cd: CASH diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml index 4f7097d4..ba5807c5 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml @@ -2,7 +2,7 @@ title: ClearingSystemIdentification2Choice description: | Specifies the clearing system identification. type: object -oneOf: +anyOf: - properties: Cd: allOf: @@ -24,4 +24,4 @@ oneOf: required: - Prtry example: - Cd: CHIPS \ No newline at end of file + Cd: CHIPS diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml index e1718d1e..a2a9eaad 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml @@ -2,7 +2,7 @@ title: CryptographicLockChoice description: | Cryptographically signed terms type: object -oneOf: +anyOf: - properties: IlpV4PrepPacket: allOf: @@ -20,4 +20,4 @@ oneOf: required: - Sh256Sgntr example: - IlpV4PrepPacket: 1234567890ABCDEF \ No newline at end of file + IlpV4PrepPacket: 1234567890ABCDEF diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact32HexBinaryText.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact32HexBinaryText.yaml index a31d3039..7830560c 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact32HexBinaryText.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact32HexBinaryText.yaml @@ -2,5 +2,4 @@ title: Exact32HexBinaryText description: | Specifies a hexadecimal string with a length of 32 characters. type: string -pattern: ^([0-9A-F][0-9A-F]){32}$ example: 1234567890ABCDEF1234567890ABCDEF diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml index 009d8b11..49a75a54 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml @@ -2,7 +2,7 @@ title: FinancialIdentificationSchemeName1Choice type: object description: > Specifies the name of the identification scheme. -oneOf: +anyOf: - properties: Cd: allOf: @@ -24,4 +24,4 @@ oneOf: required: - Prtry example: - Cd: BIC \ No newline at end of file + Cd: BIC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml index e0108829..5cda48d7 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml @@ -12,8 +12,14 @@ properties: GroupHeader Set of characteristics shared by all individual transactions included in the message. + CdtTrfTxInf: + allOf: + - $ref: ./CreditTransferTransaction68.yaml + - description: > + Credit Transfer Transaction Information required: - GrpHdr + - CdtTrfTxInf example: GrpHdr: MsgId: 12345 @@ -87,4 +93,4 @@ example: FinInstnId: BICFI: BIC Cdtr: - Nm: Name \ No newline at end of file + Nm: Name diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml index 2e78ba53..6f42477b 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml @@ -34,17 +34,11 @@ properties: - $ref: ./PaymentTypeInformation28.yaml - description: > Payment Type Information - CdtTrfTxInf: - allOf: - - $ref: ./CreditTransferTransaction68.yaml - - description: > - Credit Transfer Transaction Information required: - MsgId - CreDtTm - NbOfTxs - SttlmInf - - CdtTrfTxInf example: MsgId: 12345 CreDtTm: '2020-01-01T00:00:00Z' @@ -68,26 +62,3 @@ example: PmtTpInf: InstrPrty: NORM CtgyPurp: CASH - CdtTrfTxInf: - PmtId: - InstrId: 12345 - EndToEndId: 12345 - Amt: - InstdAmt: - Ccy: EUR - Value: 100.0 - Cdtr: - Nm: Name - CdtrAcct: - Id: - IBAN: BE71096123456769 - Ccy: EUR - CdtrAgt: - FinInstnId: - BICFI: BIC - CdtrAgtAcct: - Id: - IBAN: BE71096123456769 - Ccy: EUR - RmtInf: - Ustrd: Test diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml index af257edb..75d70be9 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml @@ -29,17 +29,11 @@ properties: - $ref: ./SettlementInstruction15.yaml - description: > Settlement Information - CdtTrfTxInf: - allOf: - - $ref: ./CreditTransferTransaction67.yaml - - description: > - Credit Transfer Transaction Information required: - MsgId - CreDtTm - NbOfTxs - SttlmInf - - CdtTrfTxInf example: MsgId: 12345 CreDtTm: '2020-01-01T00:00:00Z' @@ -54,23 +48,3 @@ example: Nm: John Doe SttlmAcctSvcr: BICFI: 123 - CdtTrfTxInf: - PmtId: - InstrId: 123 - EndToEndId: 123 - PmtTpInf: - InstrPrty: NORM - InstdAmt: - Amt: 123 - Ccy: EUR - ChrgBr: SLEV - CdtrAgt: - FinInstnId: - BICFI: 123 - Cdtr: - Nm: John Doe - CdtrAcct: - Id: - IBAN: 123 - RmtInf: - Ustrd: Test diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/IBAN2007Identifier.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/IBAN2007Identifier.yaml index eee632ba..787dbda0 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/IBAN2007Identifier.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/IBAN2007Identifier.yaml @@ -8,5 +8,5 @@ description: > International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard. type: string -pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ example: FR1420041010050500013M02606 +pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml index 7d33b034..70e6fd55 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml @@ -2,7 +2,7 @@ title: LocalInstrument2Choice type: object description: > Specifies the local instrument, as published in an external local instrument code list or as a proprietary code. -oneOf: +anyOf: - properties: Cd: allOf: @@ -24,4 +24,4 @@ oneOf: required: - Prtry example: - Cd: CH03 \ No newline at end of file + Cd: CH03 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Number.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Number.yaml index e6b1420a..ca9f9862 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Number.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Number.yaml @@ -1,4 +1,4 @@ title: Number type: string -pattern: ^[\d\-\.\,]{1,18}$ example: 256 +pattern: ^(?!0\d)\d{1,18}$ diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml index 350f1cd8..34bd6e31 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml @@ -17,7 +17,7 @@ properties: Proprietary Name of the identification scheme, in a free text form. -oneOf: +anyOf: - properties: Cd: {} - properties: diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml index 86b8d299..ac44805c 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml @@ -2,7 +2,7 @@ title: Party38Choice description: | Nature or use of the account. type: object -oneOf: +anyOf: - properties: OrgId: allOf: @@ -29,4 +29,4 @@ example: PrvtId: DtAndPlcOfBirth: Dt: '2018-01-01' - CityOfBirth: City \ No newline at end of file + CityOfBirth: City diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml index ef9ca365..64104584 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml @@ -2,7 +2,7 @@ title: Party40Choice description: | Identification of a person, an organisation or a financial institution. type: object -oneOf: +anyOf: - properties: Pty: allOf: @@ -45,4 +45,4 @@ example: AdrLine: - 1 Oxford Street - London - - UK \ No newline at end of file + - UK diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml index 2bc9e3f3..3d66cafe 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml @@ -2,7 +2,7 @@ title: Party52Choice description: | NOTE: Unsure on the description. type: object -oneOf: +anyOf: - properties: OrgId: allOf: @@ -29,4 +29,4 @@ example: PrvtId: DtAndPlcOfBirth: Dt: '2018-01-01' - CityOfBirth: City \ No newline at end of file + CityOfBirth: City diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PercentageRate.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PercentageRate.yaml index f86d6135..19971aa2 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PercentageRate.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PercentageRate.yaml @@ -1,4 +1,4 @@ title: PercentageRate type: string -pattern: ^(?=[\d\-\.\,]{1,11}$)([\d\-\,\.]{1,10})?$ 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})$ diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml index 01c0cfb5..f614e4ff 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml @@ -2,14 +2,14 @@ title: PersonIdentificationSchemeName1Choice description: | Sets of elements to identify a name of the identification scheme. type: object -oneOf: +anyOf: - properties: Cd: allOf: - $ref: ./ExternalPersonIdentification1Code.yaml - description: > Code - + Name of the identification scheme, in a coded form as published in an external list. required: - Cd @@ -24,4 +24,4 @@ oneOf: required: - Prtry example: - Cd: CCPT \ No newline at end of file + Cd: CCPT diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml index ad6eae51..25182535 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml @@ -2,7 +2,7 @@ title: ProxyAccountType1Choice description: | Specifies the type of the proxy account. type: object -oneOf: +anyOf: - properties: Cd: allOf: @@ -24,4 +24,4 @@ oneOf: required: - Prtry example: - Cd: EMAIL \ No newline at end of file + Cd: EMAIL diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml index 6b6c1f42..ba8adade 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml @@ -7,7 +7,7 @@ description: | is a content element, which is not used for processing by any of the agents involved in the payment chain. type: object -oneOf: +anyOf: - properties: Cd: allOf: @@ -29,4 +29,4 @@ oneOf: required: - Prtry example: - Cd: CH03 \ No newline at end of file + Cd: CH03 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml index 324a6336..9346221d 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml @@ -2,7 +2,7 @@ title: ServiceLevel8Choice description: | Details about a service level. type: object -oneOf: +anyOf: - properties: Cd: allOf: @@ -25,4 +25,4 @@ oneOf: required: - Prtry example: - Cd: SEPA \ No newline at end of file + Cd: SEPA diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml index def4cef0..9f8f6d37 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml @@ -2,7 +2,7 @@ title: StatusReason6Choice description: | Specifies the reason for the status. type: object -oneOf: +anyOf: - properties: Cd: allOf: @@ -24,4 +24,4 @@ oneOf: required: - Prtry example: - Cd: AGNT \ No newline at end of file + Cd: AGNT diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml index 35fe94f6..9154b945 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml @@ -9,10 +9,16 @@ properties: - $ref: ./GroupHeader129.yaml - description: > Group Header - + Set of characteristics shared by all individual transactions included in the message. + CdtTrfTxInf: + allOf: + - $ref: ./CreditTransferTransaction67.yaml + - description: > + Credit Transfer Transaction Information required: - GrpHdr + - CdtTrfTxInf example: GrpHdr: MsgId: 123456789 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/UUIDv4Identifier.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/UUIDv4Identifier.yaml index 55a9f0df..91a9ed6b 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/UUIDv4Identifier.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/UUIDv4Identifier.yaml @@ -1,4 +1,4 @@ title: UUIDv4Identifier type: string -pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$ 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}$ diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml index bf7fc4fa..50a6f73d 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml @@ -3,7 +3,7 @@ type: object description: | Choice of format for the verification reason. Only one, between the coded and the proprietary, can be chosen. -oneOf: +anyOf: - properties: Cd: allOf: @@ -26,4 +26,4 @@ oneOf: required: - Prtry example: - Cd: AGNT \ No newline at end of file + Cd: AGNT diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/hexBinary.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/hexBinary.yaml index 6365fc97..a8d0e6ba 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/hexBinary.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/hexBinary.yaml @@ -1,4 +1,4 @@ title: hexBinary type: string -pattern: ^(0x|0X)?[a-fA-F0-9]+$ example: 0x1234 +pattern: ^[A-Za-z0-9-_]+[=]{0,2}$ diff --git a/src/fspiop/v2_0_ISO20022/json-schemas.json b/src/fspiop/v2_0_ISO20022/json-schemas.json index 23eeada1..3b901b05 100644 --- a/src/fspiop/v2_0_ISO20022/json-schemas.json +++ b/src/fspiop/v2_0_ISO20022/json-schemas.json @@ -3,7 +3,7 @@ "title": "AccountIdentification4Choice", "type": "object", "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "anyOf": [ { "properties": { "IBAN": { @@ -12,8 +12,8 @@ "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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" @@ -55,7 +55,7 @@ "title": "AccountSchemeName1Choice", "type": "object", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -156,7 +156,7 @@ "title": "AccountSchemeName1Choice", "type": "object", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -216,8 +216,7 @@ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "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 } ] @@ -249,8 +248,7 @@ "ActiveCurrencyAndAmount_SimpleType": { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "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": { @@ -270,8 +268,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -305,8 +303,8 @@ "ActiveOrHistoricCurrencyAndAmount_SimpleType": { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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", @@ -332,7 +330,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -457,8 +455,8 @@ "title": "BaseOneRate", "type": "string", "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 0.7 + "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", @@ -499,7 +497,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -625,7 +623,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -904,7 +902,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -1090,7 +1088,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -1429,7 +1427,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -1555,7 +1553,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -1834,7 +1832,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -2020,7 +2018,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -2394,7 +2392,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -2723,7 +2721,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -3017,7 +3015,7 @@ "title": "AccountIdentification4Choice", "type": "object", "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "anyOf": [ { "properties": { "IBAN": { @@ -3026,8 +3024,8 @@ "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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" @@ -3069,7 +3067,7 @@ "title": "AccountSchemeName1Choice", "type": "object", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -3177,7 +3175,7 @@ "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -3274,7 +3272,7 @@ "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -3379,7 +3377,7 @@ "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -3433,7 +3431,7 @@ "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -3498,7 +3496,7 @@ "title": "ChargeType3Choice", "description": "ChargeType3Choice\nSpecifies the type of charge.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -3601,8 +3599,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -3679,7 +3677,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -3805,7 +3803,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -4084,7 +4082,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -4270,7 +4268,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -4595,7 +4593,7 @@ "title": "ChargeType3Choice", "description": "ChargeType3Choice\nSpecifies the type of charge.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -4725,7 +4723,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -4786,7 +4784,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -5420,8 +5418,8 @@ { "title": "UUIDv4Identifier", "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + "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" @@ -5495,7 +5493,7 @@ "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -5556,7 +5554,7 @@ "title": "LocalInstrument2Choice", "type": "object", "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -5617,7 +5615,7 @@ "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -5703,8 +5701,7 @@ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "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 } ] @@ -5750,8 +5747,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -5793,8 +5790,8 @@ "title": "BaseOneRate", "type": "string", "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 0.7 + "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" @@ -5832,8 +5829,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -5910,7 +5907,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -6036,7 +6033,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -6315,7 +6312,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -6501,7 +6498,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -6826,7 +6823,7 @@ "title": "ChargeType3Choice", "description": "ChargeType3Choice\nSpecifies the type of charge.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -6978,7 +6975,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -7253,7 +7250,7 @@ "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "OrgId": { @@ -7351,7 +7348,7 @@ ] } }, - "oneOf": [ + "anyOf": [ { "properties": { "Cd": {} @@ -7547,7 +7544,7 @@ "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -8005,7 +8002,7 @@ "title": "AccountIdentification4Choice", "type": "object", "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "anyOf": [ { "properties": { "IBAN": { @@ -8014,8 +8011,8 @@ "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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" @@ -8057,7 +8054,7 @@ "title": "AccountSchemeName1Choice", "type": "object", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -8165,7 +8162,7 @@ "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -8262,7 +8259,7 @@ "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -8409,7 +8406,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -8535,7 +8532,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -8814,7 +8811,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -9000,7 +8997,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -9360,7 +9357,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -9486,7 +9483,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -9765,7 +9762,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -9951,7 +9948,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -10303,7 +10300,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -10578,7 +10575,7 @@ "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "OrgId": { @@ -10676,7 +10673,7 @@ ] } }, - "oneOf": [ + "anyOf": [ { "properties": { "Cd": {} @@ -10872,7 +10869,7 @@ "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -11330,7 +11327,7 @@ "title": "AccountIdentification4Choice", "type": "object", "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "anyOf": [ { "properties": { "IBAN": { @@ -11339,8 +11336,8 @@ "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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" @@ -11382,7 +11379,7 @@ "title": "AccountSchemeName1Choice", "type": "object", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -11490,7 +11487,7 @@ "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -11587,7 +11584,7 @@ "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -11797,7 +11794,7 @@ "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", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -12002,8 +11999,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -12152,8 +12149,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -12608,8 +12605,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -12657,8 +12654,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -12713,8 +12710,8 @@ { "title": "Number", "type": "string", - "pattern": "^[\\d\\-\\.\\,]{1,18}$", - "example": 256 + "example": 256, + "pattern": "^(?!0\\d)\\d{1,18}$" }, { "description": "SequenceNumber\n\nSequential number of the tax report.\n" @@ -12950,8 +12947,8 @@ { "title": "PercentageRate", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 + "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" @@ -12970,8 +12967,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -13019,8 +13016,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -13195,8 +13192,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -13388,8 +13385,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -13748,8 +13745,8 @@ { "title": "PercentageRate", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 + "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" @@ -13768,8 +13765,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -13817,8 +13814,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -13993,8 +13990,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -14186,8 +14183,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -14371,7 +14368,7 @@ "title": "CryptographicLockChoice", "description": "Cryptographically signed terms\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "IlpV4PrepPacket": { @@ -14379,8 +14376,8 @@ { "title": "hexBinary", "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 + "example": 4660, + "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" @@ -14400,7 +14397,6 @@ "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string with a length of 32 characters.\n", "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", "example": "1234567890ABCDEF1234567890ABCDEF" }, { @@ -14593,8 +14589,8 @@ { "title": "UUIDv4Identifier", "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + "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" @@ -14668,7 +14664,7 @@ "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -14729,7 +14725,7 @@ "title": "LocalInstrument2Choice", "type": "object", "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -14790,7 +14786,7 @@ "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -14876,8 +14872,7 @@ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "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 } ] @@ -14952,7 +14947,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -15078,7 +15073,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -15357,7 +15352,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -15543,7 +15538,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -15875,7 +15870,7 @@ "title": "AccountIdentification4Choice", "type": "object", "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "anyOf": [ { "properties": { "IBAN": { @@ -15884,8 +15879,8 @@ "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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" @@ -15927,7 +15922,7 @@ "title": "AccountSchemeName1Choice", "type": "object", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -16035,7 +16030,7 @@ "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -16132,7 +16127,7 @@ "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -16279,7 +16274,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -16405,7 +16400,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -16684,7 +16679,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -16870,7 +16865,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -17230,7 +17225,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -17356,7 +17351,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -17635,7 +17630,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -17821,7 +17816,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -18181,7 +18176,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -18307,7 +18302,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -18586,7 +18581,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -18772,7 +18767,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -19104,7 +19099,7 @@ "title": "AccountIdentification4Choice", "type": "object", "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "anyOf": [ { "properties": { "IBAN": { @@ -19113,8 +19108,8 @@ "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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" @@ -19156,7 +19151,7 @@ "title": "AccountSchemeName1Choice", "type": "object", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -19264,7 +19259,7 @@ "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -19361,7 +19356,7 @@ "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -19521,7 +19516,7 @@ "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", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -19582,7 +19577,7 @@ "title": "CryptographicLockChoice", "description": "Cryptographically signed terms\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "IlpV4PrepPacket": { @@ -19590,8 +19585,8 @@ { "title": "hexBinary", "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 + "example": 4660, + "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" @@ -19611,7 +19606,6 @@ "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string with a length of 32 characters.\n", "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", "example": "1234567890ABCDEF1234567890ABCDEF" }, { @@ -19698,7 +19692,7 @@ "title": "CryptographicLockChoice", "description": "Cryptographically signed terms\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "IlpV4PrepPacket": { @@ -19706,8 +19700,8 @@ { "title": "hexBinary", "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 + "example": 4660, + "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" @@ -19727,7 +19721,6 @@ "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string with a length of 32 characters.\n", "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", "example": "1234567890ABCDEF1234567890ABCDEF" }, { @@ -20021,7 +20014,6 @@ "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string with a length of 32 characters.\n", "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", "example": "1234567890ABCDEF1234567890ABCDEF" }, "Exact4AlphaNumericText": { @@ -20151,7 +20143,7 @@ "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -20212,7 +20204,7 @@ "title": "LocalInstrument2Choice", "type": "object", "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -20273,7 +20265,7 @@ "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -20392,390 +20384,504 @@ "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", + "properties": { + "PmtId": { + "allOf": [ + { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "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" + } + ] + }, + "EndToEndId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "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" + } + ] + }, + "TxId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" + } + ] + }, + "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" + } + ] }, - "CdtTrfTxInf": { + "PmtTpInf": { "allOf": [ { - "title": "CreditTransferTransaction67", - "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", "type": "object", "properties": { - "PmtId": { + "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": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", "type": "object", - "properties": { - "InstrId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "TxId" ], "example": { - "InstrId": "INSTRUCTIONID", - "EndToEndId": "ENDTOENDID", - "TxId": "TRANSACTIONID", - "UETR": "123e4567-e89b-12d3-a456-426614174000", - "ClrSysRef": "CLRSYSREF" + "Cd": "SEPA" } }, { - "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" + "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, - "PmtTpInf": { + "LclInstrm": { "allOf": [ { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", + "title": "LocalInstrument2Choice", "type": "object", - "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", - "oneOf": [ - { - "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", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ + "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ { - "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" - ] + "title": "ExternalLocalInstrument1Code", + "description": "Specifies the external local instrument identification code.", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } - ], - "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" + ] } + }, + "required": [ + "Cd" ] }, - "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", - "oneOf": [ + { + "properties": { + "Prtry": { + "allOf": [ { - "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" - ] + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } - ], - "example": { - "Cd": "CASH" - } - }, - { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + ] } + }, + "required": [ + "Prtry" ] } - }, + ], "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" - }, - "CtgyPurp": { - "Cd": "CASH" - } + "Cd": "CH03" } }, { - "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" + "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" } ] }, - "IntrBkSttlmAmt": { + "CtgyPurp": { "allOf": [ { - "title": "ActiveCurrencyAndAmount", + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", - "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", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" ] }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "pattern": "^[A-Z]{3,3}$", - "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\".", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "ActiveCurrencyAndAmount", - "Ccy" ], "example": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Cd": "CASH" } }, { - "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" + "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" + } + ] + }, + "IntrBkSttlmAmt": { + "allOf": [ + { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "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", + "pattern": "^[A-Z]{3,3}$", + "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\".", + "example": "USD" + }, + { + "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", + "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" } ] }, - "InstdAmt": { + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR", + "SLEV" + ], + "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", + "properties": { + "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", @@ -20787,8 +20893,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -20820,668 +20926,434 @@ } }, { - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 0.7 - }, - { - "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" + "description": "Amount\nTransaction charges to be paid by the charge bearer.\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\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n", - "type": "string", - "enum": [ - "DEBT", - "CRED", - "SHAR", - "SLEV" - ], - "example": "DEBT" - }, - "ChrgsInf": { + "Agt": { "allOf": [ { - "title": "Charges16", - "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "Amt": { + "FinInstnId": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "FinancialInstitutionIdentification23", "type": "object", - "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", + "description": "Information used to identify a financial institution.\n", "properties": { - "ActiveOrHistoricCurrencyAndAmount": { + "BICFI": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "BICFIDec2014Identifier", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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": "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" + "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" } ] }, - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { + "ClrSysMmbId": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", - "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": { + "ClrSysId": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ { - "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" - ] + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "description": "Code\nClearing system identification code, as published in an external list.\n" } - ], - "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" + ] } + }, + "required": [ + "Cd" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "MmbId" ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Cd": "CHIPS" } }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "LEI": { + "MmbId": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "LEI\nLegal entity identifier of the financial institution.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - "Nm": { - "allOf": [ + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "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" + ] }, { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "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" - ], + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "example": "ADDR" + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } - ] + "description": "Issuer\nEntity that assigns the identification.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "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": [ - "Prtry" ] } + }, + "required": [ + "Id", + "Issr" ], "example": { - "Cd": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "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 } }, - "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 - } + "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "BrnchId": { + "Othr": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "GenericFinancialIdentification1", "type": "object", + "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": [ @@ -21494,1614 +21366,1256 @@ "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" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "PstlAdr": { + "SchmeNm": { "allOf": [ { - "title": "PostalAddress27", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - } - ] + "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": "GenericIdentification30", - "type": "object", - "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": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "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 + }, + "required": [ + "Prtry" + ] } - }, + ], "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" + "Cd": "BIC" } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "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, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "FinInstnId" - ], + "required": [], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "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" }, - "BrnchId": { + "Othr": { "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" - } + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "Tp": { + "BrnchId": { "allOf": [ { - "title": "ChargeType3Choice", - "description": "ChargeType3Choice\nSpecifies the type of charge.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification3", - "type": "object", - "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" + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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" ] } - }, - "required": [ - "Id" ], "example": { - "Id": 123, - "Issr": "BIC" + "Cd": "ADDR" } }, - { - "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n" + "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" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "CASH" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "Type\nDefines the type of charges.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "Amt", - "Agt" + "FinInstnId" ], "example": { - "Amt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Agt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" + "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", + "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" + ] }, - "Tp": { - "Cd": "SHAR" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification3", + "type": "object", + "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": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n" + "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", + "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" } ] }, - "Dbtr": { + "PstlAdr": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "PostalAddress27", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Nm": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "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" + ] }, { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "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" - ], + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "example": "ADDR" + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "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": [ - "Cd" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "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" - } - ] + "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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ + { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "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", + "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 }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "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\nIdentification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "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" + } + ] }, - { - "description": "Issuer\nEntity that assigns the identification.\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" + } + ] } - ] - }, - "SchmeNm": { - "allOf": [ + }, + "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 + "properties": { + "Cd": {} + } }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "properties": { + "Prtry": {} + } } - ] + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } + ] }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "ADDR" + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } } }, - "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 + { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } - }, - "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" + ] } + }, + "required": [ + "OrgId" ] }, - "Id": { - "allOf": [ - { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", - "type": "object", - "oneOf": [ + { + "properties": { + "PrvtId": { + "allOf": [ { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", "properties": { - "OrgId": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", "type": "object", "properties": { - "AnyBIC": { + "BirthDt": { "allOf": [ { - "title": "AnyBICDec2014Identifier", + "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", - "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" + "format": "date", + "example": "2013-03-07" }, { - "description": "AnyBIC\nBusiness identification code of the organisation.\n" + "description": "BirthDate\nDate on which a person was born.\n" } ] }, - "LEI": { + "PrvcOfBirth": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, - "Othr": { - "allOf": [ - { - "title": "GenericOrganisationIdentification3", - "type": "object", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { + "CityOfBirth": { "allOf": [ { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + "description": "CityOfBirth\nCity where a person was born.\n" } ] }, - "Othr": { + "CtryOfBirth": { "allOf": [ { - "title": "GenericPersonIdentification2", - "type": "object", - "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", - "oneOf": [ - { - "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" - } + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, 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": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" } }, { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\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", - "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", - "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", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" - }, - { - "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", + "title": "GenericPersonIdentification2", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 + "maxLength": 256, + "example": 256 }, { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { - "title": "AccountSchemeName1Choice", - "type": "object", + "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "type": "object", + "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", + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, @@ -23141,7 +22655,7 @@ } ], "example": { - "Cd": 1111 + "Cd": "CCPT" } }, { @@ -23171,74 +22685,681 @@ "example": { "Id": 123, "SchmeNm": { - "Cd": "IBAN" + "Cd": "DRLC" }, "Issr": "BIC" } }, { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Othr" - ] + "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" } - ], - "example": { - "IBAN": "BE71096123456769" - } - }, - { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" + ] } + }, + "required": [ + "PrvtId" ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" }, - "Tp": { - "allOf": [ - { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", - "type": "object", - "oneOf": [ - { - "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", + "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", + "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", + "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", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "AccountIdentification4Choice", + "type": "object", + "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", + "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", + "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": "Proprietary\nNature or use of the account in a proprietary form.\n" + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "Tp": { + "allOf": [ + { + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", + "type": "object", + "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" } ] } @@ -23249,71 +23370,121 @@ } ], "example": { - "Cd": "CACC" + "Cd": "EMAIL" } }, { - "description": "Type\nSpecifies the nature, or use of the account.\n" + "description": "Type\nType of the proxy identification.\n" } ] }, - "Ccy": { + "Id": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" + "minLength": 1, + "maxLength": 2048, + "example": 2048 }, { - "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" + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" }, - "Nm": { + "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", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "description": "Information used to identify a financial institution.\n", + "properties": { + "BICFI": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "BICFIDec2014Identifier", "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "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": "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" + "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" } ] }, - "Prxy": { + "ClrSysMmbId": { "allOf": [ { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "properties": { - "Tp": { + "ClrSysId": { "allOf": [ { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalProxyAccountType1Code", - "description": "Specifies the external proxy account type code.", + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 5, + "example": 12345 }, { - "description": "Code\nProxy account type, in a coded form as published in an external list.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } @@ -23335,7 +23506,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProxy account type, in a proprietary form.\n" + "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } @@ -23346,641 +23517,342 @@ } ], "example": { - "Cd": "EMAIL" + "Cd": "CHIPS" } }, { - "description": "Type\nType of the proxy identification.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "Id": { + "MmbId": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 2048, - "example": 2048 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "Id" + "MmbId" ], "example": { - "Tp": { - "Cd": "IBAN" + "ClrSysId": { + "Cd": "CHQB" }, - "Id": 123 + "MmbId": 123456789 } }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] - } - }, - "example": { - "Id": { - "IBAN": "BE71096123456769" }, - "Tp": { - "Cd": "CACC" + "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" + } + ] }, - "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { + "Nm": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "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", - "description": "Information used to identify a financial institution.\n", + "description": "Information that locates and identifies a specific address, as defined by postal services.\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": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", "properties": { - "ClrSysId": { + "Cd": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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" - ] - } + "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" ], - "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 + "example": "ADDR" }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Code\nType of address expressed as a code.\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 + "Cd" + ] }, { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "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" - ], + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "example": "ADDR" + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "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": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - ] - } + "Id", + "Issr" ], "example": { - "Cd": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "Prtry" + ] } - ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 + ], + "example": { + "Cd": "ADDR" + } }, - "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" + "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 }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "BrnchId": { + "Othr": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "GenericFinancialIdentification1", "type": "object", + "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": [ @@ -23993,1357 +23865,206 @@ "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" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "PstlAdr": { + "SchmeNm": { "allOf": [ { - "title": "PostalAddress27", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - } - ] + "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": "GenericIdentification30", - "type": "object", - "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": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "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 + }, + "required": [ + "Prtry" + ] } - }, + ], "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" + "Cd": "BIC" } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "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, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "FinInstnId" - ], + "required": [], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "BrnchId": { + "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, - "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" - } + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "CdtrAgt": { + "BrnchId": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FinInstnId": { + "Id": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "Max35Text", + "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", - "description": "Information used to identify a financial institution.\n", + "description": "Information that locates and identifies a specific address, as defined by postal services.\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": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "properties": { - "Cd": { + "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", @@ -25605,595 +24326,486 @@ } }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "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", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "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" } ] }, - "Id": { + "ClrSysMmbId": { "allOf": [ { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", "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": { + "Cd": { "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", + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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" - } + "minLength": 1, + "maxLength": 5, + "example": 12345 }, { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, - "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } - } + "required": [ + "Cd" + ] }, { - "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", "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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": { + "Prtry": { "allOf": [ { - "title": "GenericPersonIdentification2", - "type": "object", - "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", - "oneOf": [ - { - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "description": "Proprietary\nProprietary identification of the clearing system.\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": [ + "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": [ - "PrvtId" ] } + }, + "required": [ + "MmbId" ], "example": { - "OrgId": { - "AnyBIC": "BIC" + "ClrSysId": { + "Cd": "CHQB" }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } + "MmbId": 123456789 } }, { - "description": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "CtryOfRes": { + "LEI": { "allOf": [ { - "title": "CountryCode", + "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-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "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" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, - "CtctDtls": { + "Nm": { "allOf": [ { - "title": "Contact13", - "description": "Specifies the details of the contact person.\n", + "title": "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "NmPrfx": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "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" + "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" + ] }, { - "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "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" + } }, - "Nm": { - "allOf": [ - { - "title": "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" - } - ] + "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 }, - "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" - } - ] + "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 }, - "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" - } - ] + "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 }, - "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" - } - ] + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 }, - "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" - } - ] + "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 }, - "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" - } - ] + "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 }, - "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" - } - ] + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 }, - "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" - } - ] + "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 }, - "Rspnsblty": { + "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", + "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", @@ -26204,229 +24816,1131 @@ "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" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Othr": { + "SchmeNm": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "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" + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "ChanlTp" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Cd": "BIC" } }, { - "description": "OtherContact\nContact details in another form.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "PrefrdMtd": { + "Issr": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "MAIL" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, + "required": [ + "Id" + ], "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" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Id" - ], + "required": [], "example": { - "Nm": "John Doe", + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 + }, + "LEI": 123, + "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry" + "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" }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 }, - "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" + "Issr": 123 } } }, { - "description": "Creditor\nParty to which an amount of money is due.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "CdtrAcct": { + "BrnchId": { "allOf": [ { - "title": "CashAccount40", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", - "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { - "title": "AccountIdentification4Choice", + "title": "Max35Text", + "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", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", "properties": { - "IBAN": { + "AnyBIC": { "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", + "title": "AnyBICDec2014Identifier", "type": "string", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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": "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" + "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", + "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", + "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" } ] } }, - "required": [ - "IBAN" - ] + "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", "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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": "GenericAccountIdentification1", + "title": "GenericPersonIdentification2", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 + "maxLength": 256, + "example": 256 }, { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { - "title": "AccountSchemeName1Choice", - "type": "object", + "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "type": "object", + "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", + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, @@ -26466,7 +25980,7 @@ } ], "example": { - "Cd": 1111 + "Cd": "CCPT" } }, { @@ -26496,107 +26010,229 @@ "example": { "Id": 123, "SchmeNm": { - "Cd": "IBAN" + "Cd": "DRLC" }, "Issr": "BIC" } }, { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Othr" - ] + "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" } - ], - "example": { - "IBAN": "BE71096123456769" - } - }, - { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" + ] } + }, + "required": [ + "PrvtId" ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" }, - "Tp": { - "allOf": [ - { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", - "type": "object", - "oneOf": [ - { - "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" - ] - } + "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", + "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" ], - "example": { - "Cd": "CACC" - } + "type": "string", + "example": "DOCT" }, { - "description": "Type\nSpecifies the nature, or use of the account.\n" + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, - "Ccy": { + "Nm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "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" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, - "Nm": { + "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", @@ -26607,248 +26243,329 @@ "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" + "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, - "Prxy": { + "Othr": { "allOf": [ { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", "type": "object", "properties": { - "Tp": { + "ChanlTp": { "allOf": [ { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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" - } + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "Type\nType of the proxy identification.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, - "maxLength": 2048, - "example": 2048 + "maxLength": 128, + "example": 12345 }, { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Id" + "ChanlTp" ], "example": { - "Tp": { - "Cd": "IBAN" - }, - "Id": 123 + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "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", - "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" + "description": "OtherContact\nContact details in another form.\n" } ] }, - "InstrInf": { + "PrefrdMtd": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" }, { - "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" + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { - "Cd": "PHOA", - "InstrInf": "Please advise/contact next agent by phone." + "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": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" + "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" + } + } }, - "InstrForNxtAgt": { + "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", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { "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", + "title": "AccountIdentification4Choice", "type": "object", - "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" + "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" ] }, - "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" + { + "properties": { + "Othr": { + "allOf": [ + { + "title": "GenericAccountIdentification1", + "type": "object", + "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", + "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": { - "Cd": "PHOA", - "InstrInf": "Please advise/contact next agent by phone." + "IBAN": "BE71096123456769" } }, { - "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n" + "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, - "Purp": { + "Tp": { "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", + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalPurpose1Code", - "description": "Specifies the external purpose code.", + "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\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" + "description": "Code\nAccount type, in a coded form.\n" } ] } @@ -26870,7 +26587,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\n\nPurpose, in a proprietary form.\n" + "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } @@ -26881,714 +26598,402 @@ } ], "example": { - "Cd": "CH03" + "Cd": "CACC" } }, { - "description": "Purpose\nUnderlying reason for the payment transaction.\n" + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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" } ] }, - "RgltryRptg": { + "Prxy": { "allOf": [ { - "title": "RegulatoryReporting3", - "description": "Information needed due to regulatory and/or statutory requirements.\n", + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", "type": "object", "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": { + "Tp": { "allOf": [ { - "title": "RegulatoryAuthority2", - "description": "Information about an entity requiring the regulatory reporting information.\n", + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", "type": "object", - "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" + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": { - "Nm": "Swiss National Bank", - "Ctry": "CH" + "Cd": "EMAIL" } }, { - "description": "Authority\n\nEntity requiring the regulatory reporting information.\n" + "description": "Type\nType of the proxy identification.\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": [ + "Id": { + "allOf": [ { - "title": "StructuredRegulatoryReporting3", - "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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 - } + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 }, { - "items": { - "title": "StructuredRegulatoryReporting3", - "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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" + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "DbtCdtRptgInd": "CRED", - "Authrty": { - "Nm": "Swiss National Bank", - "Ctry": "CH" + "Tp": { + "Cd": "IBAN" }, - "Dtls": { - "Cd": "A1", - "Inf": "Mandatory regulatory information" - } + "Id": 123 } }, { - "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" }, - "Tax": { + "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", + "properties": { + "Cd": { "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", - "properties": { - "Cdtr": { - "allOf": [ - { - "title": "TaxParty1", - "description": "Details about the entity involved in the tax paid or to be paid.\n", - "type": "object", - "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": { + "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", + "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", + "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", + "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", + "properties": { + "Nm": { "allOf": [ { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\n", - "type": "object", - "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", - "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" - } - } + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" + "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n" } ] }, - "UltmtDbtr": { + "Ctry": { "allOf": [ { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\n", - "type": "object", - "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", - "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" - } - } + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, 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": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n" + "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n" } ] - }, - "AdmstnZone": { + } + }, + "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", + "properties": { + "Tp": { "allOf": [ { "title": "Max35Text", @@ -27599,41 +27004,54 @@ "example": 1.234567890123457e+34 }, { - "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n" + "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" } ] }, - "RefNb": { + "Dt": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "format": "date", + "example": "2013-03-07" }, { - "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n" + "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" } ] }, - "Mtd": { + "Ctry": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, 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": 35, - "example": 1.234567890123457e+34 + "maxLength": 10, + "example": 1234567890 }, { - "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n" + "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" } ] }, - "TtlTaxblBaseAmt": { + "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", @@ -27645,8 +27063,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -27678,125 +27096,350 @@ } }, { - "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" + "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" } ] }, - "TtlTaxAmt": { - "allOf": [ + "Inf": { + "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", + "anyOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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" - } - ] + "title": "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", + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, - "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", + "properties": { + "Cdtr": { + "allOf": [ + { + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "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": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" + "description": "TaxIdentification\n\nTax identification number of the creditor.\n" } ] }, - "Dt": { + "RegnId": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "format": "date", - "example": "2013-03-07" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Date\n\nDate by which tax is due.\n" + "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, - "SeqNb": { + "TaxTp": { "allOf": [ { - "title": "Number", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[\\d\\-\\.\\,]{1,18}$", - "example": 256 + "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", + "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": "SequenceNumber\n\nSequential number of the tax report.\n" + "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, - "Rcrd": { - "description": "Record\n\nDetails of the tax record.\n", - "anyOf": [ + "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": "TaxRecord3", - "description": "Set of elements used to define the tax record.\n", + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", "type": "object", "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": { + "Titl": { "allOf": [ { "title": "Max35Text", @@ -27807,26 +27450,112 @@ "example": 1.234567890123457e+34 }, { - "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" + "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, - "CtgyDtls": { + "Nm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, { - "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" + "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] - }, - "DbtrSts": { + } + }, + "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", + "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", + "properties": { + "Titl": { "allOf": [ { "title": "Max35Text", @@ -27837,214 +27566,685 @@ "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" + "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, - "FrmsCd": { + "Nm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, { - "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" + "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] - }, - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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" - } + } + }, + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "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", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "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", + "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" } ] }, - "TaxAmt": { + "TaxblBaseAmt": { "allOf": [ { - "title": "TaxAmount3", - "description": "Information on the amount of the tax record.\n", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", + "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": { - "Rate": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "PercentageRate", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 + "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": "Rate\n\nRate used to calculate the tax.\n" + "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" } ] }, - "TaxblBaseAmt": { + "Ccy": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", "type": "object", - "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": { + "FrToDt": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" }, { - "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" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "Ccy": { + "Yr": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } } }, { - "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, - "TtlAmt": { + "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", @@ -28056,8 +28256,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -28089,760 +28289,760 @@ } }, { - "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + "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" + } }, - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + { + "items": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", "type": "object", "properties": { - "Prd": { + "FrToDt": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", "type": "object", "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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": { + "FrDt": { "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", + "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", - "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" + "format": "date", + "example": "2013-03-07" }, { - "description": "Type\n\nIdentification of the period related to the tax payment.\n" + "description": "FromDate\nStart date of the range.\n" } ] }, - "Yr": { + "ToDt": { "allOf": [ { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", + "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", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 + "format": "date", + "example": "2013-03-07" }, { - "description": "Year\n\nYear related to the tax payment.\n" + "description": "ToDate\nEnd date of the range.\n" } ] } }, + "required": [ + "FrDt", + "ToDt" + ], "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, - "Amt": { + "Tp": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "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": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "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": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, - "required": [ - "Amt" - ], "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" } } }, - "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 + { + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + } + ] }, - "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", - "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", - "properties": { - "FrToDt": { + "Amt": { "allOf": [ { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", + "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": { - "FrDt": { + "ActiveOrHistoricCurrencyAndAmount": { "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", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "format": "date", - "example": "2013-03-07" + "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": "FromDate\nStart date of the range.\n" + "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" } ] }, - "ToDt": { + "Ccy": { "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", + "title": "ActiveOrHistoricCurrencyCode", "type": "string", - "format": "date", - "example": "2013-03-07" + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" }, { - "description": "ToDate\nEnd date of the range.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ - "FrDt", - "ToDt" + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" ], "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" + "description": "Amount\n\nUnderlying tax amount related to the specified period.\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", + } + }, + "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", + "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", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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", - "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" + "format": "date", + "example": "2013-03-07" }, { - "description": "Type\n\nIdentification of the period related to the tax payment.\n" + "description": "FromDate\nStart date of the range.\n" } ] }, - "Yr": { + "ToDt": { "allOf": [ { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", + "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", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 + "format": "date", + "example": "2013-03-07" }, { - "description": "Year\n\nYear related to the tax payment.\n" + "description": "ToDate\nEnd date of the range.\n" } ] } }, + "required": [ + "FrDt", + "ToDt" + ], "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + "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", + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, - "TaxAmt": { + "TtlAmt": { "allOf": [ { - "title": "TaxAmount3", - "description": "Information on the amount of the tax record.\n", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", + "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": { - "Rate": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "PercentageRate", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 + "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": "Rate\n\nRate used to calculate the tax.\n" + "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" } ] }, - "TaxblBaseAmt": { + "Ccy": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", "type": "object", - "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": { + "FrToDt": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" }, { - "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" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "Ccy": { + "Yr": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } } }, { - "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, - "TtlAmt": { + "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", @@ -28854,8 +29054,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -28887,1847 +29087,2186 @@ } }, { - "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + "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" + } }, - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + { + "items": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", "type": "object", "properties": { - "Prd": { + "FrToDt": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", "type": "object", "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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": { + "FrDt": { "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", + "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", - "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" + "format": "date", + "example": "2013-03-07" }, { - "description": "Type\n\nIdentification of the period related to the tax payment.\n" + "description": "FromDate\nStart date of the range.\n" } ] }, - "Yr": { + "ToDt": { "allOf": [ { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", + "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", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 + "format": "date", + "example": "2013-03-07" }, { - "description": "Year\n\nYear related to the tax payment.\n" + "description": "ToDate\nEnd date of the range.\n" } ] } }, + "required": [ + "FrDt", + "ToDt" + ], "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, - "Amt": { + "Tp": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "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": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "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": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, - "required": [ - "Amt" - ], "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "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", + "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" + } + ] }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, - "type": "array" - } - ] - } - }, - "example": { - "Rate": 0, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 0 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 0 + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } }, - "Dtls": { - "Tp": "T1", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } }, - "Inf": 12345 + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } } - } - }, - { - "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" + }, + "type": "array" } ] } }, "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" - } + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 }, - "TaxAmt": { - "Rate": 0.2, - "TaxblBaseAmt": { - "Ccy": "EUR", + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", "Amt": 1000 }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 200 - } - }, - "AddtlInf": "VAT applicable" + "Inf": 12345 + } } }, - "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 + { + "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" + } + ] }, - "Inf": 12345 - } - } - }, - { - "description": "Tax\nProvides details on the tax.\n" - } - ] - }, - "VrfctnOfTerms": { - "title": "CryptographicLockChoice", - "description": "Cryptographically signed terms\n", - "type": "object", - "oneOf": [ - { - "properties": { - "IlpV4PrepPacket": { - "allOf": [ - { - "title": "hexBinary", - "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 - }, - { - "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\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" } - ] - } - }, - "required": [ - "IlpV4PrepPacket" - ] - }, - { - "properties": { - "Sh256Sgntr": { - "allOf": [ - { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", - "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 1000 }, - { - "description": "SHA-256 signature of the terms\n" + "TtlAmt": { + "Ccy": "EUR", + "Amt": 200 } - ] + }, + "AddtlInf": "VAT applicable" } }, - "required": [ - "Sh256Sgntr" - ] + "type": "array" } - ], - "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" + "Cdtr": { + "Titl": "Mr", + "Nm": "John Doe" }, - "IntrBkSttlmAmt": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Dbtr": { + "Titl": "Mr", + "Nm": "John Doe" }, - "InstdAmt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "UltmtDbtr": { + "Titl": "Mr", + "Nm": "John Doe" }, - "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" - } + "AdmstnZone": "CH", + "RefNb": 12345, + "Mtd": "A", + "TtlTaxblBaseAmt": { + "Ccy": "CHF", + "Amt": 1000 }, - "DbtrAgt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" - } + "TtlTaxAmt": { + "Ccy": "CHF", + "Amt": 100 }, - "CdtrAgt": { - "BrnchId": { - "Id": "BRANCHID" + "Dt": "2018-01-01", + "SeqNb": 1, + "Rcrd": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 }, - "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" + "Inf": 12345 + } } }, { - "description": "Credit Transfer Transaction Information\n" + "description": "Tax\nProvides details on the tax.\n" } ] + }, + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "Cryptographically signed terms\n", + "type": "object", + "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 with a length of 32 characters.\n", + "type": "string", + "example": "1234567890ABCDEF1234567890ABCDEF" + }, + { + "description": "SHA-256 signature of the terms\n" + } + ] + } + }, + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } } }, "required": [ - "MsgId", - "CreDtTm", - "NbOfTxs", - "SttlmInf", - "CdtTrfTxInf" + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr" ], "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 - } + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" }, - "CdtTrfTxInf": { - "PmtId": { - "InstrId": 123, - "EndToEndId": 123 - }, - "PmtTpInf": { - "InstrPrty": "NORM" + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" }, - "InstdAmt": { - "Amt": 123, - "Ccy": "EUR" + "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" }, - "ChrgBr": "SLEV", - "CdtrAgt": { + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, "FinInstnId": { - "BICFI": 123 + "BICFI": "BICFI" } }, - "Cdtr": { - "Nm": "John Doe" + "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" }, - "CdtrAcct": { - "Id": { - "IBAN": 123 - } + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "BrnchId": { + "Id": "BRANCHID" }, - "RmtInf": { - "Ustrd": "Test" + "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": "Group Header\nSet of characteristics shared by all individual transactions included in the message.\n" + "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": "SLEV", + "CdtrAgt": { + "FinInstnId": { + "BICFI": 123 + } + }, + "Cdtr": { + "Nm": "John Doe" + }, + "CdtrAcct": { + "Id": { + "IBAN": 123 + } + }, + "RmtInf": { + "Ustrd": "Test" + } + } + } + }, + "Extension": { + "title": "Extension", + "type": "object", + "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", + "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", + "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.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "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", + "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", + "description": "Information used to identify a financial institution.\n", + "properties": { + "BICFI": { "allOf": [ { - "title": "CreditTransferTransaction67", - "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "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", "properties": { - "PmtId": { + "ClrSysId": { "allOf": [ { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", - "properties": { - "InstrId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "TxId" ], "example": { - "InstrId": "INSTRUCTIONID", - "EndToEndId": "ENDTOENDID", - "TxId": "TRANSACTIONID", - "UETR": "123e4567-e89b-12d3-a456-426614174000", - "ClrSysRef": "CLRSYSREF" + "Cd": "CHIPS" } }, { - "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "PmtTpInf": { + "MmbId": { "allOf": [ { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", - "type": "object", + "title": "Max35Text", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { "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": { + "Cd": { "allOf": [ { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", - "type": "object", - "oneOf": [ - { - "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" - ] - } + "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" ], - "example": { - "Cd": "SEPA" - } + "type": "string", + "example": "ADDR" }, { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "LclInstrm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "LocalInstrument2Choice", + "title": "GenericIdentification30", "type": "object", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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", - "oneOf": [ - { - "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" - } - ] + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "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": [ - "Prtry" ] } + }, + "required": [ + "Id", + "Issr" ], "example": { - "Cd": "CASH" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" - }, - "CtgyPurp": { - "Cd": "CASH" - } - } + "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", + "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": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "IntrBkSttlmAmt": { + "SchmeNm": { "allOf": [ { - "title": "ActiveCurrencyAndAmount", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "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", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" ] }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "pattern": "^[A-Z]{3,3}$", - "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\".", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "ActiveCurrencyAndAmount", - "Ccy" ], "example": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Cd": "BIC" } }, { - "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "InstdAmt": { + "Issr": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "Max35Text", + "description": "Specifies a character string with a 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", + "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", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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" + "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" ] }, - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Cd": "CHIPS" } }, { - "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" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "XchgRate": { + "MmbId": { "allOf": [ { - "title": "BaseOneRate", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 0.7 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "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" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - "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\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n", - "type": "string", - "enum": [ - "DEBT", - "CRED", - "SHAR", - "SLEV" - ], - "example": "DEBT" - }, - "ChrgsInf": { - "allOf": [ + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Charges16", - "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n", - "type": "object", "properties": { - "Amt": { + "Cd": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "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", - "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", + "description": "Generic scheme identification for a party.\n", "properties": { - "ActiveOrHistoricCurrencyAndAmount": { + "Id": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "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" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "Ccy": { + "Issr": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "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": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "Id", + "Issr" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" + "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", + "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", + "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" ] }, - "Agt": { + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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", + "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", + "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", + "format": "datetime", + "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", + "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": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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": { + "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", + "pattern": "^[A-Z]{3,3}$", + "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\".", + "example": "USD" + }, + { + "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", + "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", + "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", + "anyOf": [ + { + "properties": { + "Cd": { "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", + "title": "ExternalServiceLevel1Code", + "description": "Specifies the external service level code.", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "LEI\nLegal entity identifier of the financial institution.\n" + "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] - }, - "Nm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" - } + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] - }, - "Othr": { + } + }, + "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", + "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": "GenericFinancialIdentification1", - "type": "object", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } + "title": "ExternalLocalInstrument1Code", + "description": "Specifies the external local instrument identification code.", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\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 - } - } + "required": [ + "Cd" + ] }, { - "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", "properties": { - "Id": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -30738,390 +31277,201 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] - }, - "LEI": { + } + }, + "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", + "anyOf": [ + { + "properties": { + "Cd": { "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", + "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", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "example": 1234 }, { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" + "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] - }, - "Nm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" - } + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Proprietary\nCategory purpose, in a proprietary form.\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": [ + "Prtry" + ] } - ] - } - }, - "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" + ], + "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" }, - { - "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" } - ] - }, - "Tp": { - "allOf": [ - { - "title": "ChargeType3Choice", - "description": "ChargeType3Choice\nSpecifies the type of charge.\n", - "type": "object", - "oneOf": [ - { - "properties": { - "Cd": { + } + } + }, + "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", + "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", + "anyOf": [ + { + "properties": { + "Cd": { "allOf": [ { - "title": "ExternalChargeType1Code", - "description": "Specifies the type of charge applied to the transaction.\n", + "title": "ExternalServiceLevel1Code", + "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { - "description": "Code\nCharge type, in a coded form.\n" + "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } @@ -31135,51 +31485,136 @@ "Prtry": { "allOf": [ { - "title": "GenericIdentification3", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n" + "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", + "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", + "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" } ] } @@ -31194,696 +31629,929 @@ } }, { - "description": "Type\nDefines the type of charges.\n" + "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, - "required": [ - "Amt", - "Agt" - ], "example": { - "Amt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" }, - "Agt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" - } + "LclInstrm": { + "Cd": "CORE" }, - "Tp": { - "Cd": "SHAR" + "CtgyPurp": { + "Cd": "CASH" } } }, { - "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n" + "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 }, - "Dbtr": { + "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", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", "type": "object", "properties": { - "Nm": { + "InstrId": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "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" } ] }, - "PstlAdr": { + "EndToEndId": { "allOf": [ { - "title": "PostalAddress27", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "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" + } + ] + }, + "TxId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" + } + ] + }, + "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", + "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "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", + "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", + "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" + } + ] + }, + "IntrBkSttlmAmt": { + "allOf": [ + { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "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", + "pattern": "^[A-Z]{3,3}$", + "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\".", + "example": "USD" + }, + { + "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", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "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", "properties": { - "Cd": { + "ClrSysId": { "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" + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "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", - "example": "ADDR" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "Cd" - ] + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Prtry": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "example": "ADDR" }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "SchmeNm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "GenericIdentification30", + "type": "object", + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "Prtry" + ] } - ] - } - }, - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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" - } + "Cd": "ADDR" } }, - { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "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" } - }, - "required": [ - "OrgId" ] }, - { - "properties": { - "PrvtId": { - "allOf": [ - { - "title": "PersonIdentification18", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ + "Othr": { + "allOf": [ + { + "title": "GenericFinancialIdentification1", + "type": "object", + "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", + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", "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": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", "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" + "maxLength": 4, + "example": 1234 }, { - "description": "CountryOfBirth\nCountry where a person was born.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" - ], - "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" - } + "Cd" + ] }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" - } - ] - }, - "Othr": { - "allOf": [ - { - "title": "GenericPersonIdentification2", - "type": "object", - "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", - "oneOf": [ - { - "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": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -31894,210 +32562,102 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\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" + "Prtry" + ] } - ] - } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 + ], + "example": { + "Cd": "BIC" } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" } - } + ] }, - { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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": [ - "PrvtId" ] } - ], + }, + "required": [], "example": { - "OrgId": { - "AnyBIC": "BIC" + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "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": "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" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "CtctDtls": { + "BrnchId": { "allOf": [ { - "title": "Contact13", - "description": "Specifies the details of the contact person.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "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": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -32108,163 +32668,361 @@ "example": 1.234567890123457e+34 }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "Rspnsblty": { + "LEI": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, - "Dept": { + "Nm": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "maxLength": 140, + "example": 12345 }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, - "Othr": { + "PstlAdr": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "PostalAddress27", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "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": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 128, - "example": 12345 + "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" + ] }, { - "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" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "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": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\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" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "Id" + "FinInstnId" ], "example": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "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" } - }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" } } }, @@ -32286,7 +33044,7 @@ "title": "AccountIdentification4Choice", "type": "object", "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "anyOf": [ { "properties": { "IBAN": { @@ -32295,8 +33053,8 @@ "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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" @@ -32338,7 +33096,7 @@ "title": "AccountSchemeName1Choice", "type": "object", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -32446,7 +33204,7 @@ "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -32543,7 +33301,7 @@ "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -32645,7 +33403,7 @@ } }, { - "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" + "description": "DebtorAccount\nAccount used to process a payment.\n" } ] }, @@ -32690,7 +33448,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -32816,7 +33574,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -33095,7 +33853,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -33281,7 +34039,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -33641,7 +34399,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -33767,7 +34525,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -34046,7 +34804,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -34232,7 +34990,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -34554,661 +35312,475 @@ "Cdtr": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "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": { + "FinInstnId": { "allOf": [ { - "title": "PostalAddress27", + "title": "FinancialInstitutionIdentification23", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "description": "Information used to identify a financial institution.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "BICFI": { + "allOf": [ { - "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" - ] + "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", "properties": { - "Prtry": { + "ClrSysId": { "allOf": [ { - "title": "GenericIdentification30", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", - "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" + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "Id", - "Issr" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Cd": "CHIPS" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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": [ - "Prtry" - ] + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + { + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } - ], - "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 + "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" + } + ] }, - "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" + "Nm": { + "allOf": [ + { + "title": "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" + } + ] }, - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "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" + "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" ] }, - "Othr": { - "allOf": [ - { - "title": "GenericOrganisationIdentification3", - "type": "object", - "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", - "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" - } - ] + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "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 }, - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } - }, - "oneOf": [ + ] + }, + "Issr": { + "allOf": [ { - "properties": { - "Cd": {} - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "properties": { - "Prtry": {} - } + "description": "Issuer\nEntity that assigns the identification.\n" } - ], - "example": { - "Cd": "BIC" - } + ] }, - { - "description": "SchemeName\nName of the identification scheme.\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" + } }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] + { + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + ] } + }, + "required": [ + "Prtry" ] } - }, + ], "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } + "Cd": "ADDR" } }, - { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "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" } - }, - "required": [ - "OrgId" ] }, - { - "properties": { - "PrvtId": { - "allOf": [ - { - "title": "PersonIdentification18", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ + "Othr": { + "allOf": [ + { + "title": "GenericFinancialIdentification1", + "type": "object", + "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", + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", "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": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", "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" + "maxLength": 4, + "example": 1234 }, { - "description": "CountryOfBirth\nCountry where a person was born.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" - ], - "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" - } + "Cd" + ] }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" - } - ] - }, - "Othr": { - "allOf": [ - { - "title": "GenericPersonIdentification2", - "type": "object", - "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", - "oneOf": [ - { - "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": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -35219,210 +35791,102 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\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" + "Prtry" + ] } - ] - } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 + ], + "example": { + "Cd": "BIC" } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" } - } + ] }, - { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" - } - ] - } - }, - "required": [ - "PrvtId" - ] - } - ], - "example": { - "OrgId": { - "AnyBIC": "BIC" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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 }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "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": "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" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "CtctDtls": { + "BrnchId": { "allOf": [ { - "title": "Contact13", - "description": "Specifies the details of the contact person.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "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": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -35433,163 +35897,361 @@ "example": 1.234567890123457e+34 }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "Rspnsblty": { + "LEI": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, - "Dept": { + "Nm": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "maxLength": 140, + "example": 12345 }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, - "Othr": { + "PstlAdr": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "PostalAddress27", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "ChanlTp": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "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" + ] }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "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" + } }, - "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" - } - ] + "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 } }, - "required": [ - "ChanlTp" - ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "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": "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" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\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" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "Id" + "FinInstnId" ], "example": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "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" } - }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" } } }, @@ -35611,7 +36273,7 @@ "title": "AccountIdentification4Choice", "type": "object", "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "anyOf": [ { "properties": { "IBAN": { @@ -35620,8 +36282,8 @@ "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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" @@ -35663,7 +36325,7 @@ "title": "AccountSchemeName1Choice", "type": "object", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -35771,7 +36433,7 @@ "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -35868,7 +36530,7 @@ "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -35970,7 +36632,7 @@ } }, { - "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" + "description": "CreditorAccount\nAccount to which a credit entry is made.\n" } ] }, @@ -36022,63 +36684,13 @@ } ] }, - "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", - "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", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -36133,533 +36745,424 @@ } ] }, - "RgltryRptg": { + "VrfctnOfTerms": { "allOf": [ { - "title": "RegulatoryReporting3", - "description": "Information needed due to regulatory and/or statutory requirements.\n", + "title": "CryptographicLockChoice", + "description": "Cryptographically signed terms\n", + "type": "object", + "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 with a length of 32 characters.\n", + "type": "string", + "example": "1234567890ABCDEF1234567890ABCDEF" + }, + { + "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", + "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", + "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", + "format": "datetime", + "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", + "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": { - "DbtCdtRptgInd": { + "ActiveCurrencyAndAmount": { "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", + "title": "ActiveCurrencyAndAmount_SimpleType", "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" + "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 } ] }, - "Authrty": { + "Ccy": { "allOf": [ { - "title": "RegulatoryAuthority2", - "description": "Information about an entity requiring the regulatory reporting information.\n", - "type": "object", - "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", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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 - } + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "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\".", + "example": "USD" }, { - "items": { - "title": "StructuredRegulatoryReporting3", - "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], "example": { - "DbtCdtRptgInd": "CRED", - "Authrty": { - "Nm": "Swiss National Bank", - "Ctry": "CH" - }, - "Dtls": { - "Cd": "A1", - "Inf": "Mandatory regulatory information" - } + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" + "description": "Total Interbank Settlement Amount\n" } ] }, - "Tax": { + "SttlmInf": { "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", + "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", "properties": { - "Cdtr": { - "allOf": [ - { - "title": "TaxParty1", - "description": "Details about the entity involved in the tax paid or to be paid.\n", - "type": "object", - "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" - } - ] + "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" }, - "Dbtr": { - "allOf": [ - { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\n", - "type": "object", - "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": [ + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "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", + "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 + "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" + ] }, { - "description": "TaxType\n\nType of tax payer.\n" - } - ] - }, - "Authstn": { - "allOf": [ - { - "title": "TaxAuthorisation1", - "description": "Details of an authorised tax paying party.\n", - "type": "object", "properties": { - "Titl": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -36670,112 +37173,57 @@ "example": 1.234567890123457e+34 }, { - "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" + "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] - }, - "Nm": { + } + }, + "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", + "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": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "ExternalLocalInstrument1Code", + "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, - "maxLength": 140, + "maxLength": 35, "example": 12345 }, { - "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" + "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\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", - "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 + "required": [ + "Cd" + ] }, { - "description": "TaxType\n\nType of tax payer.\n" - } - ] - }, - "Authstn": { - "allOf": [ - { - "title": "TaxAuthorisation1", - "description": "Details of an authorised tax paying party.\n", - "type": "object", "properties": { - "Titl": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -36786,978 +37234,1387 @@ "example": 1.234567890123457e+34 }, { - "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" + "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] - }, - "Nm": { + } + }, + "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", + "anyOf": [ + { + "properties": { + "Cd": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", + "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, - "maxLength": 140, - "example": 12345 + "type": "string", + "example": 1234 }, { - "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" + "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, - "example": { - "Titl": "Mr", - "Nm": "John Doe" - } + "required": [ + "Cd" + ] }, { - "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT", - "Authstn": { - "Titl": "Mr", - "Nm": "John Doe" + ], + "example": { + "Cd": "CASH" + } + }, + { + "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } - } - }, - { - "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 + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" }, - { - "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 + "LclInstrm": { + "Cd": "CORE" }, - { - "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n" + "CtgyPurp": { + "Cd": "CASH" } - ] - }, - "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 + } + } + }, + "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" }, - { - "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n" + "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", + "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" }, - "TtlTaxblBaseAmt": { + "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": "ActiveOrHistoricCurrencyAndAmount", + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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" + "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" ] }, - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Cd": "SEPA" } }, { - "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" + "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, - "TtlTaxAmt": { + "LclInstrm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "LocalInstrument2Choice", "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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" + "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" ] }, - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Cd": "CH03" } }, { - "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" + "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" } ] }, - "SeqNb": { + "CtgyPurp": { "allOf": [ { - "title": "Number", + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "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", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { + "allOf": [ + { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[\\d\\-\\.\\,]{1,18}$", - "example": 256 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "SequenceNumber\n\nSequential number of the tax report.\n" + "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" } ] }, - "Rcrd": { - "description": "Record\n\nDetails of the tax record.\n", - "anyOf": [ + "EndToEndId": { + "allOf": [ { - "title": "TaxRecord3", - "description": "Set of elements used to define the tax record.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "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" + } + ] + }, + "TxId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" + } + ] + }, + "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", + "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", - "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" + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] - }, - "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" + } + ], + "example": { + "Cd": "SEPA" + } + }, + { + "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" + } + ] + }, + "LclInstrm": { + "allOf": [ + { + "title": "LocalInstrument2Choice", + "type": "object", + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] - }, - "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" + } + ], + "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", + "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" ] }, - "FrmsCd": { + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" + } + ] + }, + "IntrBkSttlmAmt": { + "allOf": [ + { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "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", + "pattern": "^[A-Z]{3,3}$", + "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\".", + "example": "USD" + }, + { + "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", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "description": "Information used to identify a financial institution.\n", + "properties": { + "BICFI": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "BICFIDec2014Identifier", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" + "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" } ] }, - "Prd": { + "ClrSysMmbId": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "properties": { - "FrToDt": { + "ClrSysId": { "allOf": [ { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", - "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" + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "FrDt", - "ToDt" ], "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + "Cd": "CHIPS" } }, { - "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" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "Yr": { + "MmbId": { "allOf": [ { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Year\n\nYear related to the tax payment.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, + "required": [ + "MmbId" + ], "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "TaxAmt": { + "LEI": { "allOf": [ { - "title": "TaxAmount3", - "description": "Information on the amount of the tax record.\n", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Rate": { - "allOf": [ - { - "title": "PercentageRate", - "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 - }, - { - "description": "Rate\n\nRate used to calculate the tax.\n" - } - ] - }, - "TaxblBaseAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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": { + "Cd": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "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", - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" + "example": "ADDR" }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "Cd" + ] }, { - "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", "properties": { - "Prd": { + "Prtry": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "GenericIdentification30", "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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": { + "Id": { "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", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Type\n\nIdentification of the period related to the tax payment.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\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", - "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": { + "Issr": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "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" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "Ccy": { + "SchmeNm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "Id", + "Issr" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } - } + "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", + "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 }, { - "items": { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", - "type": "object", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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" - } - ] - } + "description": "Identification\nUnique and unambiguous identification of a person.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "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 }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } - }, - { - "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" - } + "required": [ + "Prtry" + ] } - }, - "type": "array" + ], + "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": { - "Rate": 0, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 0 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 0 + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - "Dtls": { - "Tp": "T1", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 - }, - "Inf": 12345 - } + "Issr": "BIC" } }, { - "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" + "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 }, - "Tp": { + "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", + "properties": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -37768,2666 +38625,1793 @@ "example": 1.234567890123457e+34 }, { - "description": "Type\n\nHigh level code to identify the type of tax details.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\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 - } + "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" + } + ] }, - "AddtlInf": "VAT applicable" - } - }, - { - "items": { - "title": "TaxRecord3", - "description": "Set of elements used to define the tax record.\n", - "type": "object", - "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", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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" + "Nm": { + "allOf": [ + { + "title": "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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" + } + ] + } }, - { - "description": "ToDate\nEnd date of the range.\n" + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } - ] - } - }, - "required": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] } }, - { - "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" - } - ] + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" } }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "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 } }, - { - "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", - "properties": { - "Rate": { - "allOf": [ - { - "title": "PercentageRate", - "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 - }, - { - "description": "Rate\n\nRate used to calculate the tax.\n" - } - ] - }, - "TaxblBaseAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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" - } - ] - } + "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", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "AccountIdentification4Choice", + "type": "object", + "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", + "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 }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } + { + "description": "Identification\nIdentification assigned by an institution.\n" } - }, - { - "items": { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "AccountSchemeName1Choice", "type": "object", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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" - } - ] + "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 }, - "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": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } - } - }, - { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + ] } + }, + "required": [ + "Cd" ] }, - "Amt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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" - } - ] + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Amt" ], "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } + "Cd": 1111 } }, - "type": "array" - } - ] - } - }, - "example": { - "Rate": 0, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 0 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 0 + { + "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" + } + ] + } }, - "Dtls": { - "Tp": "T1", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - "Inf": 12345 + "Issr": "BIC" } + }, + { + "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } - }, - { - "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" + "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", + "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" + } + ] } }, - "TaxAmt": { - "Rate": 0.2, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 1000 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 200 + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" + } + ] } }, - "AddtlInf": "VAT applicable" + "required": [ + "Prtry" + ] } - }, - "type": "array" + ], + "example": { + "Cd": "CACC" + } + }, + { + "description": "Type\nSpecifies the nature, or use of the account.\n" } ] - } - }, - "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", - "oneOf": [ - { - "properties": { - "IlpV4PrepPacket": { + "Ccy": { "allOf": [ { - "title": "hexBinary", + "title": "ActiveOrHistoricCurrencyCode", "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" }, { - "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" + "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" } ] - } - }, - "required": [ - "IlpV4PrepPacket" - ] - }, - { - "properties": { - "Sh256Sgntr": { + }, + "Nm": { "allOf": [ { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, { - "description": "SHA-256 signature of the terms\n" + "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", + "properties": { + "Tp": { + "allOf": [ + { + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", + "type": "object", + "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" } ] } }, - "required": [ - "Sh256Sgntr" - ] + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + { + "description": "DebtorAccount\nAccount used to process a payment.\n" } - ], - "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": "SLEV", - "CdtrAgt": { - "FinInstnId": { - "BICFI": 123 - } - }, - "Cdtr": { - "Nm": "John Doe" - }, - "CdtrAcct": { - "Id": { - "IBAN": 123 - } - }, - "RmtInf": { - "Ustrd": "Test" - } - } - } - }, - "Extension": { - "title": "Extension", - "type": "object", - "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", - "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", - "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.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "properties": { - "ClrSysId": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - ] - }, - { + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "Prtry": { + "FinInstnId": { "allOf": [ { - "title": "GenericIdentification30", + "title": "FinancialInstitutionIdentification23", "type": "object", - "description": "Generic scheme identification for a party.\n", + "description": "Information used to identify a financial institution.\n", "properties": { - "Id": { + "BICFI": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "BICFIDec2014Identifier", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "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" } ] }, - "Issr": { + "ClrSysMmbId": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, - "SchmeNm": { + "Nm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", - "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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" + } + ] }, - { - "description": "Code\nClearing system identification code, as published in an external list.\n" + "Othr": { + "allOf": [ + { + "title": "GenericFinancialIdentification1", + "type": "object", + "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", + "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": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "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 } - ] - } - }, - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "BrnchId": { "allOf": [ { - "title": "GenericIdentification30", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", - "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "Issr": { + "LEI": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, - "SchmeNm": { + "Nm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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" } ] } }, - "required": [ - "Id", - "Issr" - ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "Prtry" - ] + "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" } - ], - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "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", - "format": "datetime", - "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": { + "CdtrAgt": { "allOf": [ { - "title": "ActiveCurrencyAndAmount", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", - "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "ActiveCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount_SimpleType", - "type": "string", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - } - ] - }, - "Ccy": { + "FinInstnId": { "allOf": [ { - "title": "ActiveCurrencyCode", - "type": "string", - "pattern": "^[A-Z]{3,3}$", - "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\".", - "example": "USD" - }, - { - "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", - "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", - "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", - "oneOf": [ + "title": "FinancialInstitutionIdentification23", + "type": "object", + "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", "properties": { - "Cd": { + "ClrSysId": { "allOf": [ { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "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": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -40438,57 +40422,325 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "Prtry" - ] + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + { + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } - ], - "example": { - "Cd": "SEPA" - } + ] }, - { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" - } - ] - }, - "LclInstrm": { - "allOf": [ - { - "title": "LocalInstrument2Choice", - "type": "object", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Cd": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "ExternalLocalInstrument1Code", - "description": "Specifies the external local instrument identification code.", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 12345 + "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" + ] }, { - "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "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 } }, - "required": [ - "Cd" - ] + "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", + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { - "Prtry": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -40499,56 +40751,72 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\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", - "oneOf": [ - { - "properties": { - "Cd": { + }, + "SchmeNm": { "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 + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "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": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -40559,275 +40827,346 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nCategory purpose, in a proprietary form.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Prtry" - ] + "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" } - ], - "example": { - "Cd": "CASH" - } + ] + } + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "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 } - ] - } - }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" + } }, - "CtgyPurp": { - "Cd": "CASH" + { + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } - } - } - }, - "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", - "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": { + "BrnchId": { "allOf": [ { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, - { - "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", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalLocalInstrument1Code", - "description": "Specifies the external local instrument identification code.", + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, + "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 }, - { - "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", + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 16, + "example": 1234567890123456 }, - { - "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", - "oneOf": [ - { - "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, + "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", - "example": 1234 + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 }, - { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "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", @@ -40835,1004 +41174,522 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Proprietary\nCategory purpose, in a proprietary form.\n" + "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" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "CASH" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, + "required": [ + "FinInstnId" + ], "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "CtgyPurp": { - "Cd": "CASH" + "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": "Payment Type Information\n" + "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, - "CdtTrfTxInf": { + "Cdtr": { "allOf": [ { - "title": "CreditTransferTransaction68", - "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "PmtId": { + "FinInstnId": { "allOf": [ { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", + "title": "FinancialInstitutionIdentification23", "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "InstrId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" - } - ] - }, - "ClrSysRef": { + "BICFI": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "BICFIDec2014Identifier", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" + "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" } ] - } - }, - "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", - "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": { + "ClrSysMmbId": { "allOf": [ { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", - "oneOf": [ - { - "properties": { - "Cd": { - "allOf": [ + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "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" + ] }, { - "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "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": [ - "Prtry" ] } + }, + "required": [ + "MmbId" ], "example": { - "Cd": "SEPA" - } - }, - { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" - } - ] - }, - "LclInstrm": { - "allOf": [ - { - "title": "LocalInstrument2Choice", - "type": "object", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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" - ] + "ClrSysId": { + "Cd": "CHQB" }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" + "MmbId": 123456789 } }, { - "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" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "CtgyPurp": { + "LEI": { "allOf": [ { - "title": "CategoryPurpose1Choice", - "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", - "type": "object", - "oneOf": [ - { - "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" - } + "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": "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" - } - ] - }, - "IntrBkSttlmAmt": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "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", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, - "Ccy": { + "Nm": { "allOf": [ { - "title": "ActiveCurrencyCode", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", - "pattern": "^[A-Z]{3,3}$", - "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\".", - "example": "USD" + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { + }, + "PstlAdr": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "PostalAddress24", "type": "object", - "description": "Information used to identify a financial institution.\n", + "description": "Information that locates and identifies a specific address, as defined by postal services.\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": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", "properties": { - "ClrSysId": { + "Cd": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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" - ] - } + "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" ], - "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 + "example": "ADDR" }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 - } + "Cd" + ] }, { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "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" - ], + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "example": "ADDR" + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } - ] + "description": "Issuer\nEntity that assigns the identification.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "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": [ - "Prtry" ] } + }, + "required": [ + "Id", + "Issr" ], "example": { - "Cd": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "Prtry" + ] } - ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 + ], + "example": { + "Cd": "ADDR" + } }, - "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" + "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 }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "BrnchId": { + "Othr": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "GenericFinancialIdentification1", "type": "object", + "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": [ @@ -41845,932 +41702,601 @@ "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" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "PstlAdr": { + "SchmeNm": { "allOf": [ { - "title": "PostalAddress27", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - } - ] + "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": "GenericIdentification30", - "type": "object", - "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": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "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 + }, + "required": [ + "Prtry" + ] } - }, + ], "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" + "Cd": "BIC" } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "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, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "FinInstnId" - ], + "required": [], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "BrnchId": { + "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, - "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" - } + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "DbtrAcct": { + "BrnchId": { "allOf": [ { - "title": "CashAccount40", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", - "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" - }, - { - "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", - "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", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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" - } + "title": "Max35Text", + "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\nSpecifies the nature, or use of the account.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "Ccy": { + "LEI": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "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", - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "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" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "maxLength": 140, + "example": 12345 }, { - "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" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, - "Prxy": { + "PstlAdr": { "allOf": [ { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", + "title": "PostalAddress27", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Tp": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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" - } - ] + "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": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "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" + } + ] }, - { - "description": "Proprietary\nProxy account type, in a proprietary form.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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": "EMAIL" - } - }, - { - "description": "Type\nType of the proxy identification.\n" + }, + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "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" - } - ] + "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 } }, - "required": [ - "Id" - ], "example": { - "Tp": { - "Cd": "IBAN" - }, - "Id": 123 + "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": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" - }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" } } }, { - "description": "DebtorAccount\nAccount used to process a payment.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "DbtrAgt": { + "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", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "AccountIdentification4Choice", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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" - } - ] + "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}$" }, - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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" - } - ] + { + "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", + "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 }, - "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" - } - ] + { + "description": "Identification\nIdentification assigned by an institution.\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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "SchmeNm": { + "allOf": [ + { + "title": "AccountSchemeName1Choice", "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "description": "Sets of elements to identify a name of the identification scheme.\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" - ], + "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", - "example": "ADDR" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } @@ -42784,67 +42310,15 @@ "Prtry": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -42855,106 +42329,17 @@ } ], "example": { - "Cd": "ADDR" + "Cd": 1111 } }, - "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": { + { + "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", @@ -42962,206 +42347,739 @@ "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 + { + "description": "Issuer\nEntity that assigns the identification.\n" } - }, - "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" - } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "Tp": { + "allOf": [ + { + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", + "type": "object", + "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" ] }, - "Othr": { - "allOf": [ - { - "title": "GenericFinancialIdentification1", - "type": "object", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } - ] + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] + { + "description": "Proprietary\nProxy account type, in a proprietary form.\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": [ + "Prtry" ] } - }, - "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 - } + "Cd": "EMAIL" } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "Type\nType of the proxy identification.\n" } ] }, - "BrnchId": { + "Id": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "type": "object", + "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", + "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", + "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", + "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 with a length of 32 characters.\n", + "type": "string", + "example": "1234567890ABCDEF1234567890ABCDEF" + }, + { + "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": "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": "SLEV", + "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", + "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", + "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", + "format": "datetime", + "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", + "format": "datetime", + "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", + "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", + "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", + "anyOf": [ + { "properties": { - "Id": { + "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", @@ -43172,945 +43090,1050 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] - }, - "LEI": { + } + }, + "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", + "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": "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", + "title": "ExternalLocalInstrument1Code", + "description": "Specifies the external local instrument identification code.", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 35, + "example": 12345 }, { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" + "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] - }, - "Nm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] - }, - "PstlAdr": { + } + }, + "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", + "anyOf": [ + { + "properties": { + "Cd": { "allOf": [ { - "title": "PostalAddress27", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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": "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } - } + "required": [ + "Cd" + ] }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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", + "properties": { + "PmtId": { + "allOf": [ + { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "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" + } + ] + }, + "EndToEndId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "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" + } + ] + }, + "TxId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" + } + ] + }, + "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", + "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", + "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" ] } - }, - "required": [ - "FinInstnId" ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "Cd": "SEPA" + } + }, + { + "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" + } + ] + }, + "LclInstrm": { + "allOf": [ + { + "title": "LocalInstrument2Choice", + "type": "object", + "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" + ] }, - "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" - } + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" + "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" } ] }, - "CdtrAgt": { + "CtgyPurp": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "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" + } + ] + }, + "IntrBkSttlmAmt": { + "allOf": [ + { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "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", + "pattern": "^[A-Z]{3,3}$", + "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\".", + "example": "USD" + }, + { + "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", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "FinInstnId": { + "BICFI": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "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", - "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": { + "ClrSysId": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ { - "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" - ] + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "description": "Code\nClearing system identification code, as published in an external list.\n" } - ], - "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" + ] } + }, + "required": [ + "Cd" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "MmbId" ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Cd": "CHIPS" } }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "LEI": { + "MmbId": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "LEI\nLegal entity identifier of the financial institution.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - "Nm": { - "allOf": [ + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "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" + ] }, { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "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" - ], + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "example": "ADDR" + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } - ] + "description": "Issuer\nEntity that assigns the identification.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "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": [ - "Prtry" ] } + }, + "required": [ + "Id", + "Issr" ], "example": { - "Cd": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "Prtry" + ] } - ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 + ], + "example": { + "Cd": "ADDR" + } }, - "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" + "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 }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "BrnchId": { + "Othr": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "GenericFinancialIdentification1", "type": "object", + "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": [ @@ -44123,1021 +44146,601 @@ "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" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "PstlAdr": { + "SchmeNm": { "allOf": [ { - "title": "PostalAddress27", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - } - ] + "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": "GenericIdentification30", - "type": "object", - "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": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "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 + }, + "required": [ + "Prtry" + ] } - }, + ], "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" + "Cd": "BIC" } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "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, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "FinInstnId" - ], + "required": [], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "BrnchId": { + "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, - "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" - } + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "Cdtr": { + "BrnchId": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FinInstnId": { + "Id": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "Max35Text", + "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", - "description": "Information used to identify a financial institution.\n", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "BICFI": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "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", "properties": { - "ClrSysId": { + "Cd": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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" - ] - } + "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" ], - "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 + "example": "ADDR" }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Code\nType of address expressed as a code.\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 + "Cd" + ] }, { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "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" - ], + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "example": "ADDR" + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } - ] + "description": "Issuer\nEntity that assigns the identification.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "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": [ - "Prtry" ] } + }, + "required": [ + "Id", + "Issr" ], "example": { - "Cd": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "Prtry" + ] } - ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 + ], + "example": { + "Cd": "ADDR" + } }, - "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" + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] - }, - "BrnchId": { - "allOf": [ - { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "type": "object", - "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" - } - ] + } + }, + "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", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "AccountIdentification4Choice", + "type": "object", + "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}$" }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + { + "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", + "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" + } + ] }, - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "SchmeNm": { + "allOf": [ + { + "title": "AccountSchemeName1Choice", "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "description": "Sets of elements to identify a name of the identification scheme.\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" - ], + "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", - "example": "ADDR" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } @@ -45151,67 +44754,15 @@ "Prtry": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -45222,342 +44773,337 @@ } ], "example": { - "Cd": "ADDR" + "Cd": 1111 } }, - "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", + { + "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": 140, - "example": 12345 + "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 - }, - "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 + { + "description": "Issuer\nEntity that assigns the identification.\n" } - }, - "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" + }, + "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" } - } - }, - { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + ] } + }, + "required": [ + "Othr" ] } - }, - "required": [ - "FinInstnId" ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "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", + "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" + ] }, - "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" - } + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "Creditor\nParty to which an amount of money is due.\n" + "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, - "CdtrAcct": { + "Ccy": { "allOf": [ { - "title": "CashAccount40", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", - "description": "Provides the details to identify an account.\n", "properties": { - "Id": { + "Tp": { "allOf": [ { - "title": "AccountIdentification4Choice", + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "anyOf": [ { "properties": { - "IBAN": { + "Cd": { "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", + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", "type": "string", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "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" + "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ - "IBAN" + "Cd" ] }, { "properties": { - "Othr": { + "Prtry": { "allOf": [ { - "title": "GenericAccountIdentification1", - "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "title": "Max35Text", + "description": "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", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "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", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ + { "properties": { - "Id": { + "Cd": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\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", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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 - } + "maxLength": 5, + "example": 12345 }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] - }, - "Issr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -45568,160 +45114,390 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nProprietary identification of the clearing system.\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" + "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": [ - "Othr" ] } + }, + "required": [ + "MmbId" ], "example": { - "IBAN": "BE71096123456769" + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "Tp": { + "LEI": { "allOf": [ { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", - "type": "object", - "oneOf": [ - { - "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" - } + "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": "Type\nSpecifies the nature, or use of the account.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, - "Ccy": { + "Nm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "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" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, - "Nm": { + "PstlAdr": { "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 + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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": "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" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "Prxy": { + "Othr": { "allOf": [ { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", + "title": "GenericFinancialIdentification1", "type": "object", + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { - "Tp": { + "Id": { "allOf": [ { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", + "title": "Max35Text", + "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", - "oneOf": [ + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalProxyAccountType1Code", - "description": "Specifies the external proxy account type code.", + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification 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" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } @@ -45743,7 +45519,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProxy account type, in a proprietary form.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -45754,26 +45530,26 @@ } ], "example": { - "Cd": "EMAIL" + "Cd": "BIC" } }, { - "description": "Type\nType of the proxy identification.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "Id": { + "Issr": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 2048, - "example": 2048 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } @@ -45782,60 +45558,92 @@ "Id" ], "example": { - "Tp": { + "Id": 123, + "SchmeNm": { "Cd": "IBAN" }, - "Id": 123 + "Issr": "BIC" } }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, + "required": [], "example": { - "Id": { - "IBAN": "BE71096123456769" + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "Tp": { - "Cd": "CACC" + "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" }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "CreditorAccount\nAccount to which a credit entry is made.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "InstrForCdtrAgt": { + "BrnchId": { "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", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalCreditorAgentInstruction1Code", - "description": "Specifies the instruction given by the creditor to the creditor agent.", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "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": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, - "InstrInf": { + "Nm": { "allOf": [ { "title": "Max140Text", @@ -45846,55 +45654,241 @@ "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", - "oneOf": [ - { - "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" - } - ] + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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", @@ -45902,588 +45896,195 @@ "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", - "oneOf": [ - { - "properties": { - "IlpV4PrepPacket": { - "allOf": [ - { - "title": "hexBinary", + "Ctry": { + "title": "CountryCode", "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, 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": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" - } - ] - } - }, - "required": [ - "IlpV4PrepPacket" - ] - }, - { - "properties": { - "Sh256Sgntr": { - "allOf": [ - { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" - }, - { - "description": "SHA-256 signature of the terms\n" + "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" } - }, - "required": [ - "Sh256Sgntr" ] } - ], + }, "example": { - "IlpV4PrepPacket": "1234567890ABCDEF" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "PmtId", - "IntrBkSttlmAmt", - "Dbtr", - "Cdtr" + "FinInstnId" ], "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" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "CdtrAcct": { - "Id": { - "IBAN": "IBAN" + "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" } - }, - "InstrForCdtrAgt": { - "Cd": "INSTRUCTION" - }, - "Purp": { - "Cd": "CHAR" - }, - "VrfctnOfTerms": { - "Cntt": "CONTENT", - "CnttTp": "PROPRIETARY" } } }, { - "description": "Credit Transfer Transaction Information\n" - } - ] - } - }, - "required": [ - "MsgId", - "CreDtTm", - "NbOfTxs", - "SttlmInf", - "CdtTrfTxInf" - ], - "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" - }, - "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" - } - }, - "CdtrAgtAcct": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Ccy": "EUR" - }, - "RmtInf": { - "Ustrd": "Test" - } - } - } - }, - { - "description": "GroupHeader\nSet of characteristics shared by all individual transactions included in the message.\n" - } - ] - } - }, - "required": [ - "GrpHdr" - ], - "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", - "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", - "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", - "format": "datetime", - "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" + "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" } ] }, - "TtlIntrBkSttlmAmt": { + "CdtrAgt": { "allOf": [ { - "title": "ActiveCurrencyAndAmount", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", - "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "ActiveCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount_SimpleType", - "type": "string", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - } - ] - }, - "Ccy": { + "FinInstnId": { "allOf": [ { - "title": "ActiveCurrencyCode", - "type": "string", - "pattern": "^[A-Z]{3,3}$", - "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\".", - "example": "USD" - }, - { - "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", - "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", - "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", - "oneOf": [ + "title": "FinancialInstitutionIdentification23", + "type": "object", + "description": "Information used to identify a financial institution.\n", + "properties": { + "BICFI": { + "allOf": [ { - "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" - ] + "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" }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "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" } - ], - "example": { - "Cd": "SEPA" - } + ] }, - { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" - } - ] - }, - "LclInstrm": { - "allOf": [ - { - "title": "LocalInstrument2Choice", - "type": "object", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ + "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", "properties": { - "Cd": { + "ClrSysId": { "allOf": [ { - "title": "ExternalLocalInstrument1Code", - "description": "Specifies the external local instrument identification code.", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 12345 + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "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": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -46494,214 +46095,206 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "Prtry" - ] + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + { + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } - ], - "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", - "oneOf": [ + "LEI": { + "allOf": [ { - "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" - ] + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Prtry": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\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 + "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" + ] }, { - "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", - "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", - "oneOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "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": 4, - "example": 1234 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "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": [ - { + "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", @@ -46709,60 +46302,39 @@ "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", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalLocalInstrument1Code", - "description": "Specifies the external local instrument identification code.", + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "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", @@ -46770,59 +46342,23 @@ "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", - "oneOf": [ - { - "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, + "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", - "example": 1234 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -46830,1004 +46366,1003 @@ "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" - } - ] - }, - "CdtTrfTxInf": { - "allOf": [ - { - "title": "CreditTransferTransaction68", - "description": "Provides further details specific to the individual transaction(s) included in the message.\n", - "type": "object", - "properties": { - "PmtId": { - "allOf": [ - { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", - "type": "object", - "properties": { - "InstrId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "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", - "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", - "oneOf": [ - { - "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" - ] + "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" }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "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": { - "Cd": "SEPA" + "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": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "LclInstrm": { + "Othr": { "allOf": [ { - "title": "LocalInstrument2Choice", + "title": "GenericFinancialIdentification1", "type": "object", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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", - "oneOf": [ - { - "properties": { - "Cd": { - "allOf": [ + "SchmeNm": { + "allOf": [ + { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ { - "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 + "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" + ] }, { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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": [ - "Prtry" ] } + }, + "required": [ + "Id" ], "example": { - "Cd": "CASH" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, + "required": [], "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "LclInstrm": { - "Cd": "CORE" + "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" }, - "CtgyPurp": { - "Cd": "CASH" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "IntrBkSttlmAmt": { + "BrnchId": { "allOf": [ { - "title": "ActiveCurrencyAndAmount", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", - "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": { + "Id": { "allOf": [ { - "title": "ActiveCurrencyAndAmount_SimpleType", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "Ccy": { + "LEI": { "allOf": [ { - "title": "ActiveCurrencyCode", + "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-Z]{3,3}$", - "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\".", - "example": "USD" + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { + }, + "Nm": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "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", - "description": "Information used to identify a financial institution.\n", + "description": "Information that locates and identifies a specific address, as defined by postal services.\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": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", "properties": { - "ClrSysId": { + "Cd": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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" - ] - } + "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" ], - "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 + "example": "ADDR" }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Code\nType of address expressed as a code.\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 + "Cd" + ] }, { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "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" - ], + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "example": "ADDR" + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "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": [ - "Cd" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "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" - } - ] + "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", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "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", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "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": [ - "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" + }, + "required": [ + "Cd" + ] }, - "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 + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": { - "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" + "Cd": "CHIPS" } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "Othr": { + "MmbId": { "allOf": [ { - "title": "GenericFinancialIdentification1", - "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "title": "Max35Text", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { "properties": { - "Id": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "example": "ADDR" }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "SchmeNm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "GenericIdentification30", "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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": [ - "Prtry" ] } + }, + "required": [ + "Id", + "Issr" ], "example": { - "Cd": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "Prtry" + ] } - ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 + ], + "example": { + "Cd": "ADDR" + } }, - "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" + "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 }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "BrnchId": { + "Othr": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "GenericFinancialIdentification1", "type": "object", + "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": [ @@ -47840,557 +47375,806 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "LEI": { + "SchmeNm": { "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" + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "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": "LEI\nLegal entity identification for the branch of the financial institution.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "Nm": { + "Issr": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress27", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" + "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", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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": "Code\nType of address expressed as a code.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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": [ - "Prtry" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - ], - "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" + "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": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "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": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\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" - } + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" } } }, { - "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "DbtrAcct": { + "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", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { "allOf": [ { - "title": "CashAccount40", + "title": "AccountIdentification4Choice", "type": "object", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "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", + "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { - "IBAN": { + "Id": { "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", + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 }, { - "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" + "description": "Identification\nIdentification assigned by an institution.\n" } ] - } - }, - "required": [ - "IBAN" - ] - }, - { - "properties": { - "Othr": { + }, + "SchmeNm": { "allOf": [ { - "title": "GenericAccountIdentification1", + "title": "AccountSchemeName1Choice", "type": "object", - "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", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "description": "Sets of elements to identify a name of the identification scheme.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ { - "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" - ] + "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 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } - ], - "example": { - "Cd": 1111 - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" + ] } + }, + "required": [ + "Cd" ] }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "Id" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "Cd": 1111 } }, { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + "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": [ - "Othr" - ] + "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" } - ], - "example": { - "IBAN": "BE71096123456769" - } - }, - { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { "Tp": { "allOf": [ { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", "type": "object", - "oneOf": [ + "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", + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { - "description": "Code\nAccount type, in a coded form.\n" + "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } @@ -48412,7 +48196,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } @@ -48423,4143 +48207,1224 @@ } ], "example": { - "Cd": "CACC" + "Cd": "EMAIL" } }, { - "description": "Type\nSpecifies the nature, or use of the account.\n" + "description": "Type\nType of the proxy identification.\n" } ] }, - "Ccy": { + "Id": { "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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 - } + "maxLength": 2048, + "example": 2048 }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "Id": { - "IBAN": "BE71096123456769" - }, "Tp": { - "Cd": "CACC" + "Cd": "IBAN" }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 - } + "Id": 123 } }, { - "description": "DebtorAccount\nAccount used to process a payment.\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" }, - "DbtrAgt": { + "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", + "properties": { + "Cd": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } - ] + "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPurpose1Code", + "description": "Specifies the external purpose code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, - "BrnchId": { - "allOf": [ - { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" - } - ] + { + "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" } - }, - "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "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": "Proprietary\n\nPurpose, in a proprietary form.\n" } - } - }, - { - "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\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", + "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" ] }, - "CdtrAgt": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } - ] + { + "properties": { + "Sh256Sgntr": { + "allOf": [ + { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "example": "1234567890ABCDEF1234567890ABCDEF" }, - "BrnchId": { - "allOf": [ - { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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": "SHA-256 signature of the terms\n" } - } - }, - { - "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\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": "SLEV", + "CdtrAgt": { + "FinInstnId": { + "BICFI": "CCCCCCCC" + } + }, + "Cdtr": { + "Nm": "Creditor Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "BE71096123456769" + } + }, + "RmtInf": { + "Ustrd": "Payment for invoice 12345" + } + } + } + }, + "GenericAccountIdentification1": { + "title": "GenericAccountIdentification1", + "type": "object", + "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", + "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 }, - "Cdtr": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" - }, - { - "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", - "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", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "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", - "oneOf": [ - { - "properties": { - "IlpV4PrepPacket": { - "allOf": [ - { - "title": "hexBinary", - "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 - }, - { - "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" - } - ] - } - }, - "required": [ - "IlpV4PrepPacket" - ] - }, - { - "properties": { - "Sh256Sgntr": { - "allOf": [ - { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", - "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" - }, - { - "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" - } - ] + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\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" + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "VrfctnOfTerms": { - "Cntt": "CONTENT", - "CnttTp": "PROPRIETARY" + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } - } - }, - { - "description": "Credit Transfer Transaction Information\n" + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "MsgId", - "CreDtTm", - "NbOfTxs", - "SttlmInf", - "CdtTrfTxInf" ], "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" - }, - "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" - } - }, - "CdtrAgtAcct": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Ccy": "EUR" - }, - "RmtInf": { - "Ustrd": "Test" - } - } + "Cd": 1111 } }, { - "description": "GroupHeader\nSet of characteristics shared by all individual transactions included in the message.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "CdtTrfTxInf": { + "Issr": { "allOf": [ { - "title": "CreditTransferTransaction68", - "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "title": "Max35Text", + "description": "Specifies a character string with a 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", + "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", - "properties": { - "PmtId": { - "allOf": [ - { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", - "type": "object", - "properties": { - "InstrId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" - } - ] + "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 }, - "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" - } - ] + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\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" + ] } + }, + "required": [ + "Cd" ] }, - "PmtTpInf": { - "allOf": [ - { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", - "type": "object", - "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", + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "enum": [ - "RTGS", - "RTNS", - "MPNS", - "BOOK" - ], - "example": "RTGS" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "SvcLvl": { - "allOf": [ - { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", - "type": "object", - "oneOf": [ - { - "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" - } - ] + { + "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", + "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", + "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", + "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", + "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", + "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", + "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", + "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, - "LclInstrm": { - "allOf": [ - { - "title": "LocalInstrument2Choice", - "type": "object", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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" - } - ] + { + "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 }, - "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", - "oneOf": [ - { - "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" - } - ] + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } - }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" + ] + } + }, + "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", + "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, - "LclInstrm": { - "Cd": "CORE" + { + "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 }, - "CtgyPurp": { - "Cd": "CASH" + { + "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", + "properties": { + "Assgnmt": { + "allOf": [ + { + "title": "IdentificationAssignment3", + "type": "object", + "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": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" + "description": "MessageIdentification\nUnique identification, as assigned by the assigner, to unambiguously identify the message.\n" } ] }, - "IntrBkSttlmAmt": { + "CreDtTm": { "allOf": [ { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "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", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "pattern": "^[A-Z]{3,3}$", - "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\".", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "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", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" }, { - "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" + "description": "CreationDateTime\nDate and time at which the identification assignment was created.\n" } ] }, - "Dbtr": { + "Assgnr": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "Party40Choice", + "description": "Identification of a person, an organisation or a financial institution.\n", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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" + "anyOf": [ + { + "properties": { + "Pty": { + "allOf": [ + { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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" + } + ] }, - { - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "oneOf": [ + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "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", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "example": "ADDR" }, { - "description": "Code\nClearing system identification code, as published in an external list.\n" + "description": "Code\nType of address expressed as a code.\n" } ] } @@ -52573,15 +49438,67 @@ "Prtry": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "GenericIdentification30", + "type": "object", + "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\nProprietary identification of the clearing system.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } @@ -52592,1717 +49509,1397 @@ } ], "example": { - "Cd": "CHIPS" + "Cd": "ADDR" } }, - { - "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", + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" - } - ] - } - }, - "required": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" + "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" + } }, - "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] }, - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "Id": { + "allOf": [ + { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { - "Cd": { + "OrgId": { "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" + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "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", + "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", + "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": "Code\nType of address expressed as a code.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ - "Cd" + "OrgId" ] }, { "properties": { - "Prtry": { + "PrvtId": { "allOf": [ { - "title": "GenericIdentification30", + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", "type": "object", - "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": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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": "Issuer\nEntity that assigns the identification.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, - "SchmeNm": { + "Othr": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "GenericPersonIdentification1", + "type": "object", + "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", + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Id", - "Issr" - ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ - "Prtry" + "PrvtId" ] } ], "example": { - "Cd": "ADDR" + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } } }, - "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": { + { + "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" }, - "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 + { + "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" } - }, - "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", - "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 + "CtctDtls": { + "allOf": [ + { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "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" + } + ] }, - { - "description": "Identification\nUnique and unambiguous identification of a person.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "Nm": { + "allOf": [ + { + "title": "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", "properties": { - "Cd": { + "ChanlTp": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", + "title": "Max4Text", + "description": "Specifies a 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" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 128, + "example": 12345 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Prtry" - ] + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + { + "description": "Other\nContact details in another form.\n" } - ], - "example": { - "Cd": "BIC" - } + ] }, - { - "description": "SchemeName\nName of the identification scheme.\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" + } + ] } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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" + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + { + "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\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", - "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 + "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" }, - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" + "Id": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Prtry": "DfspId" } - }, - "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" + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" } - ] - } - }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" + } + }, + { + "description": "Party\nIdentification of a person or an organisation.\n" } - } - }, - { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + ] } + }, + "required": [ + "Pty" ] - } - }, - "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", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" - }, - { - "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": { + "Agt": { + "allOf": [ { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "Othr": { + "FinInstnId": { "allOf": [ { - "title": "GenericAccountIdentification1", + "title": "FinancialInstitutionIdentification18", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "description": "Information used to identify a financial institution.\n", "properties": { - "Id": { + "BICFI": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "title": "BICFIDec2014Identifier", "type": "string", - "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 + "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": "Identification\nIdentification assigned by an institution.\n" + "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" } ] }, - "SchmeNm": { + "ClrSysMmbId": { "allOf": [ { - "title": "AccountSchemeName1Choice", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "properties": { - "Cd": { - "allOf": [ + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ { - "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 + "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" + ] }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "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": [ - "Prtry" ] } + }, + "required": [ + "MmbId" ], "example": { - "Cd": 1111 + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "Issr": { + "LEI": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\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", - "oneOf": [ - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "properties": { - "Cd": { + "Nm": { "allOf": [ { - "title": "ExternalProxyAccountType1Code", - "description": "Specifies the external proxy account type code.", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 140, + "example": 12345 }, { - "description": "Code\nProxy account type, in a coded form as published in an external list.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "PstlAdr": { "allOf": [ { - "title": "Max35Text", - "description": "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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" - ] - }, - { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Prtry": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\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 + "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" + ] }, { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "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" ] } - }, - "required": [ - "Id", - "Issr" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Cd": "ADDR" } }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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" } - }, - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "Othr": { + "allOf": [ { + "title": "GenericFinancialIdentification1", + "type": "object", + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "SchmeNm": { + "allOf": [ + { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "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", @@ -54313,531 +50910,539 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Prtry" - ] + "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" } - ], - "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 + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "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 } - ] - } - }, - "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", - "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" + } + ] }, - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "BrnchId": { + "allOf": [ + { + "title": "BranchData3", "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "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" + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "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" + } + } }, - "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 + { + "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" } - }, - "example": { + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { "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" + "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": "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": "Agent\nIdentification of a financial institution.\n" } - } - }, - { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + ] } + }, + "required": [ + "Agt" ] } - }, - "required": [ - "FinInstnId" ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, + "Pty": { "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" + "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": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" + "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n" } ] }, - "CdtrAgt": { + "Assgne": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "Party40Choice", + "description": "Identification of a person, an organisation or a financial institution.\n", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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" + "anyOf": [ + { + "properties": { + "Pty": { + "allOf": [ + { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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" + } + ] }, - { - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "oneOf": [ + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "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", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "example": "ADDR" }, { - "description": "Code\nClearing system identification code, as published in an external list.\n" + "description": "Code\nType of address expressed as a code.\n" } ] } @@ -54851,15 +51456,67 @@ "Prtry": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "GenericIdentification30", + "type": "object", + "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\nProprietary identification of the clearing system.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } @@ -54870,17 +51527,42 @@ } ], "example": { - "Cd": "CHIPS" + "Cd": "ADDR" } }, - { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" - } - ] - }, - "MmbId": { - "allOf": [ - { + "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", @@ -54888,1323 +51570,1354 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "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 } - ] - } - }, - "required": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" + }, + "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" + } }, - "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] }, - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "Id": { + "allOf": [ + { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - ] - }, + "anyOf": [ { "properties": { - "Prtry": { + "OrgId": { "allOf": [ { - "title": "GenericIdentification30", + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { + "AnyBIC": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "AnyBICDec2014Identifier", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, - "Issr": { + "LEI": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, - "SchmeNm": { + "Othr": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "GenericOrganisationIdentification1", + "type": "object", + "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", + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Id", - "Issr" - ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ - "Prtry" + "OrgId" + ] + }, + { + "properties": { + "PrvtId": { + "allOf": [ + { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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", + "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", + "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": { - "Cd": "ADDR" + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } } }, - "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": { + { + "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" }, - "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 + { + "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" } - }, - "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", - "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 + "CtctDtls": { + "allOf": [ + { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "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" + } + ] }, - { - "description": "Identification\nUnique and unambiguous identification of a person.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "Nm": { + "allOf": [ + { + "title": "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", "properties": { - "Cd": { + "ChanlTp": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", + "title": "Max4Text", + "description": "Specifies a 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" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 128, + "example": 12345 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Prtry" - ] + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + { + "description": "Other\nContact details in another form.\n" } - ], - "example": { - "Cd": "BIC" - } + ] }, - { - "description": "SchemeName\nName of the identification scheme.\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" + } }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] + { + "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" + } } - }, - "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" + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" } - ] - } - }, - "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": "Party\nIdentification of a person or an organisation.\n" } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + ] } + }, + "required": [ + "Pty" ] }, - "BrnchId": { - "allOf": [ - { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + { + "properties": { + "Agt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification18", "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "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": [ + "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", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "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 + "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" + ] }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" + } }, - "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" - } - ] + { + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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" - } - ] + "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": [ - "Cd" - ] + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } - ], - "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 + "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" + } + ] }, - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - } - ] + "Nm": { + "allOf": [ + { + "title": "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "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" + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "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" ] } - }, - "required": [ - "Id", - "Issr" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Cd": "ADDR" } }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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" } - }, - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "Othr": { + "allOf": [ { + "title": "GenericFinancialIdentification1", + "type": "object", + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "SchmeNm": { + "allOf": [ + { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "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", @@ -56215,130 +52928,626 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Prtry" - ] + "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" } - ], - "example": { - "Cd": "BIC" - } + ] + } + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - { - "description": "SchemeName\nName of the identification scheme.\n" + "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 } - ] + } }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + { + "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", + "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" + } + ] }, - { - "description": "Issuer\nEntity that assigns the identification.\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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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" + } + ] } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + }, + "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" + } + } }, - "Issr": "BIC" - } + { + "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" }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "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" + } } - ] - } - }, - "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" + { + "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", + "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", + "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 }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + { + "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n" } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + ] } + }, + "required": [ + "Cd" ] }, - "BrnchId": { + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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", + "description": "Information that locates and identifies a specific party or account.\n", + "properties": { + "Pty": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "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": [ { @@ -56350,14 +53559,14 @@ "example": 12345 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { - "title": "PostalAddress27", + "title": "PostalAddress24", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -56365,7 +53574,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -56472,14 +53681,6 @@ "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", @@ -56497,12 +53698,12 @@ "example": 1.2345678901234567e+99 }, "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", @@ -56513,12 +53714,12 @@ "example": 1234567890123456 }, "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", @@ -56528,14 +53729,6 @@ "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", @@ -56561,28 +53754,28 @@ "example": 1234567890123456 }, "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", @@ -56610,14 +53803,12 @@ }, "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", @@ -56633,342 +53824,930 @@ "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", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" - }, - { - "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": [ + "Id": { + "allOf": [ + { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "anyOf": [ { - "title": "GenericAccountIdentification1", - "type": "object", - "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": { + "OrgId": { "allOf": [ { - "title": "AccountSchemeName1Choice", + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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", + "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" + } + ] }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "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" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": 1111 + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } } }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] - }, - "Issr": { + } + }, + "required": [ + "OrgId" + ] + }, + { + "properties": { + "PrvtId": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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", + "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", + "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": "Issuer\nEntity that assigns the identification.\n" + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" - } + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" }, - { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } - ] + } + }, + { + "description": "Identification\nUnique and unambiguous way to identify an organisation.\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", - "oneOf": [ - { - "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" - } - ] + }, + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "CtctDtls": { + "allOf": [ + { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "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" + } + ] }, - { - "description": "Proprietary\nNature or use of the account in a proprietary form.\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", + "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": [ - "Prtry" ] } + }, + "required": [ + "Id" ], "example": { - "Cd": "CACC" + "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": "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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" + "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, - "Prxy": { + "Acct": { "allOf": [ { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", + "title": "CashAccount40", "type": "object", + "description": "Provides the details to identify an account.\n", "properties": { + "Id": { + "allOf": [ + { + "title": "AccountIdentification4Choice", + "type": "object", + "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", + "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", + "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": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalProxyAccountType1Code", - "description": "Specifies the external proxy account type code.", + "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\nProxy account type, in a coded form as published in an external list.\n" + "description": "Code\nAccount type, in a coded form.\n" } ] } @@ -56990,7 +54769,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProxy account type, in a proprietary form.\n" + "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } @@ -57001,936 +54780,469 @@ } ], "example": { - "Cd": "EMAIL" + "Cd": "CACC" } }, { - "description": "Type\nType of the proxy identification.\n" + "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, - "Id": { + "Ccy": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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": 2048, - "example": 2048 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + "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", + "properties": { + "Tp": { + "allOf": [ + { + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", + "type": "object", + "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" } ] } }, - "required": [ - "Id" - ], "example": { + "Id": { + "IBAN": "BE71096123456769" + }, "Tp": { - "Cd": "IBAN" + "Cd": "CACC" }, - "Id": 123 + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } } }, { - "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", - "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" + "description": "Account\nUnambiguous identification of the account of a party.\n" } ] }, - "InstrInf": { + "Agt": { "allOf": [ { - "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", - "oneOf": [ - { - "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", - "oneOf": [ - { - "properties": { - "IlpV4PrepPacket": { - "allOf": [ - { - "title": "hexBinary", - "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 - }, - { - "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" - } - ] - } - }, - "required": [ - "IlpV4PrepPacket" - ] - }, - { - "properties": { - "Sh256Sgntr": { - "allOf": [ - { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", - "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" - }, - { - "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": "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": "SLEV", - "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", - "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", - "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", - "format": "datetime", - "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", - "format": "datetime", - "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", - "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", - "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", - "oneOf": [ + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "Cd": { + "BICFI": { "allOf": [ { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", + "title": "BICFIDec2014Identifier", "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "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": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" + "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" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "ClrSysMmbId": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "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": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\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", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "properties": { - "Cd": { + }, + "LEI": { "allOf": [ { - "title": "ExternalLocalInstrument1Code", - "description": "Specifies the external local instrument identification code.", + "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", - "minLength": 1, - "maxLength": 35, - "example": 12345 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Nm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 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", - "oneOf": [ - { - "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 + "maxLength": 140, + "example": 12345 }, { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "PstlAdr": { "allOf": [ { - "title": "Max35Text", - "description": "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" - } - ] - }, - "CdtTrfTxInf": { - "allOf": [ - { - "title": "CreditTransferTransaction67", - "description": "Provides further details specific to the individual transaction(s) included in the message.\n", - "type": "object", - "properties": { - "PmtId": { - "allOf": [ - { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", - "type": "object", - "properties": { - "InstrId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "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", - "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", - "oneOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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": 4, - "example": 1234 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "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": [ - { + "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", @@ -57938,60 +55250,47 @@ "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", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalLocalInstrument1Code", - "description": "Specifies the external local instrument identification code.", + "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": 12345 + "example": 1.234567890123457e+34 }, - { - "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -57999,59 +55298,416 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" + "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", + "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", + "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": [ - "Prtry" ] } - ], + }, + "required": [], "example": { - "Cd": "CH03" + "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": "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" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, - "CtgyPurp": { + "BrnchId": { "allOf": [ { - "title": "CategoryPurpose1Choice", - "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "title": "BranchData3", "type": "object", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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", @@ -58059,321 +55715,303 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Proprietary\nCategory purpose, in a proprietary form.\n" + "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" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "CASH" + "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": "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" - } - ] - }, - "IntrBkSttlmAmt": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "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", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "pattern": "^[A-Z]{3,3}$", - "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\".", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "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": [ - "ActiveCurrencyAndAmount", - "Ccy" + "FinInstnId" ], "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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" - } - ] + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] + "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" + } } - }, - "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" + "description": "Agent\nFinancial institution servicing an account for a party.\n" } ] - }, - "XchgRate": { - "allOf": [ - { - "title": "BaseOneRate", - "type": "string", - "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 0.7 - }, - { - "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" + } + }, + "required": [ + "Pty" + ], + "example": { + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } } - ] + }, + "CtryOfRes": "FI" }, - "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\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n", - "type": "string", - "enum": [ - "DEBT", - "CRED", - "SHAR", - "SLEV" - ], - "example": "DEBT" + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } }, - "ChrgsInf": { + "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", + "description": "Information that locates and identifies a specific party or account.\n", + "properties": { + "Pty": { "allOf": [ { - "title": "Charges16", - "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n", + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "properties": { - "Amt": { + "Nm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, - "Agt": { + "PstlAdr": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "PostalAddress24", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "FinInstnId": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "description": "Information used to identify a financial institution.\n", "properties": { - "BICFI": { + "Cd": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "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", - "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" + "example": "ADDR" }, { - "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" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "ClrSysMmbId": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "GenericIdentification30", "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "ClrSysId": { + "Id": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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" - } + "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": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "MmbId": { + "SchmeNm": { "allOf": [ { "title": "Max35Text", @@ -58384,1102 +56022,23 @@ "example": 1.234567890123457e+34 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "MmbId" + "Id", + "Issr" ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } @@ -59493,14 +56052,6 @@ "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", @@ -59518,12 +56069,12 @@ "example": 1.2345678901234567e+99 }, "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", @@ -59534,12 +56085,12 @@ "example": 1234567890123456 }, "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", @@ -59549,14 +56100,6 @@ "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", @@ -59582,28 +56125,28 @@ "example": 1234567890123456 }, "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", @@ -59631,14 +56174,12 @@ }, "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", @@ -59651,23 +56192,23 @@ } }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "PostalAddress\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", + "title": "Party38Choice", + "description": "Nature or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "OrgId": { "allOf": [ { - "title": "OrganisationIdentification39", + "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "properties": { @@ -59702,22 +56243,22 @@ "Othr": { "allOf": [ { - "title": "GenericOrganisationIdentification3", + "title": "GenericOrganisationIdentification1", "type": "object", - "description": "Information related to an identification of an organisation.\n", + "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 256, - "example": 256 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, @@ -59759,7 +56300,7 @@ ] } }, - "oneOf": [ + "anyOf": [ { "properties": { "Cd": {} @@ -59840,7 +56381,7 @@ "PrvtId": { "allOf": [ { - "title": "PersonIdentification18", + "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "properties": { @@ -59930,19 +56471,19 @@ "Othr": { "allOf": [ { - "title": "GenericPersonIdentification2", + "title": "GenericPersonIdentification1", "type": "object", - "description": "Identification of a person.", + "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 256, - "example": 256 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" @@ -59955,7 +56496,7 @@ "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -60058,7 +56599,7 @@ } }, { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } @@ -60081,7 +56622,7 @@ } }, { - "description": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, @@ -60095,14 +56636,14 @@ "description": "Code to identify a country, a dependency, 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" + "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": "Contact13", + "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "properties": { @@ -60121,7 +56662,7 @@ "example": "DOCT" }, { - "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" + "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, @@ -60179,7 +56720,7 @@ } ] }, - "URLAdr": { + "EmailAdr": { "allOf": [ { "title": "Max2048Text", @@ -60189,21 +56730,6 @@ "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" } @@ -60316,15 +56842,15 @@ } }, { - "description": "OtherContact\nContact details in another form.\n" + "description": "Other\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", + "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", @@ -60333,10 +56859,10 @@ "FAXX", "CELL" ], - "example": "MAIL" + "example": "CELL" }, { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } @@ -60347,12 +56873,11 @@ "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" + "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } @@ -60368,19 +56893,25 @@ "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" + "Ctry": "Ctry", + "AdrLine": "AdrLine" }, "Id": { "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "Othr": { + "Id": 123, + "SchmeNm": { + "Prtry": "DfspId" + } } } }, @@ -60396,11 +56927,11 @@ } }, { - "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" + "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, - "DbtrAcct": { + "Acct": { "allOf": [ { "title": "CashAccount40", @@ -60413,7 +56944,7 @@ "title": "AccountIdentification4Choice", "type": "object", "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "anyOf": [ { "properties": { "IBAN": { @@ -60422,8 +56953,8 @@ "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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" @@ -60465,7 +56996,7 @@ "title": "AccountSchemeName1Choice", "type": "object", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -60573,7 +57104,7 @@ "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -60670,7 +57201,7 @@ "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -60772,21 +57303,21 @@ } }, { - "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" + "description": "Account\nUnambiguous identification of the account of a party.\n" } ] }, - "DbtrAgt": { + "Agt": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "FinancialInstitutionIdentification18", "type": "object", "description": "Information used to identify a financial institution.\n", "properties": { @@ -60800,7 +57331,7 @@ "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" + "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" } ] }, @@ -60817,7 +57348,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -60943,7 +57474,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -61222,7 +57753,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -61342,16 +57873,16 @@ } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "BranchData3", "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ @@ -61378,7 +57909,7 @@ "example": "529900T8BM49AURSDO55" }, { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" + "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, @@ -61400,7 +57931,7 @@ "PstlAdr": { "allOf": [ { - "title": "PostalAddress27", + "title": "PostalAddress24", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -61408,7 +57939,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -61515,14 +58046,6 @@ "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", @@ -61540,12 +58063,12 @@ "example": 1.2345678901234567e+99 }, "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", @@ -61556,12 +58079,12 @@ "example": 1234567890123456 }, "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", @@ -61571,14 +58094,6 @@ "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", @@ -61604,28 +58119,28 @@ "example": 1234567890123456 }, "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", @@ -61653,14 +58168,12 @@ }, "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", @@ -61673,26 +58186,30 @@ } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Postal Address\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" + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" } } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "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" } ] } @@ -61723,77 +58240,375 @@ } }, { - "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" + "description": "Agent\nFinancial institution servicing an account for a party.\n" } ] + } + }, + "required": [ + "Pty" + ], + "example": { + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" }, - "CdtrAgt": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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" - } - ] + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } + } + } + }, + { + "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n" + } + ] + } + }, + "required": [ + "OrgnlId", + "Vrfctn", + "UpdtdPtyAndAcctId" + ], + "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", + "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" + }, + { + "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", + "properties": { + "Assgnmt": { + "allOf": [ + { + "title": "IdentificationAssignment3", + "type": "object", + "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", + "format": "datetime", + "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", + "anyOf": [ + { + "properties": { + "Pty": { + "allOf": [ + { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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 }, - "ClrSysMmbId": { - "allOf": [ - { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + { + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ + "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", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "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": 5, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nClearing system identification code, as published in an external list.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "SchmeNm": { "allOf": [ { "title": "Max35Text", @@ -61804,148 +58619,391 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Prtry" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - ], - "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": [ + "Prtry" ] } - }, - "required": [ - "MmbId" ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Cd": "ADDR" } }, - { - "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", + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "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", + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + "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" + } }, - "PstlAdr": { - "allOf": [ + { + "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", + "anyOf": [ { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "OrgId": { + "allOf": [ { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", "properties": { - "Cd": { + "AnyBIC": { "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" - ], + "title": "AnyBICDec2014Identifier", "type": "string", - "example": "ADDR" + "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": "Code\nType of address expressed as a code.\n" + "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", + "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", + "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" } ] } }, - "required": [ - "Cd" - ] + "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", "properties": { - "Prtry": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "GenericIdentification30", + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", "type": "object", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { + "BirthDt": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "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", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "format": "date", + "example": "2013-03-07" }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "BirthDate\nDate on which a person was born.\n" } ] }, - "Issr": { + "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", @@ -61956,11 +59014,11 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, - "SchmeNm": { + "CityOfBirth": { "allOf": [ { "title": "Max35Text", @@ -61971,461 +59029,126 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "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": [ - "Id", - "Issr" + "BirthDt", + "CityOfBirth", + "CtryOfBirth" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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": { + "Othr": { "allOf": [ { - "title": "GenericIdentification30", + "title": "GenericPersonIdentification1", "type": "object", - "description": "Generic scheme identification for a party.\n", + "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Issr": { + "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 + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "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": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "SchmeNm": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -62436,77 +59159,113 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Id", - "Issr" + "Id" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Prtry" - ] + "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", + "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" ], - "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 + "example": "DOCT" }, - "BldgNm": { + { + "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", @@ -62514,71 +59273,98 @@ "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", + { + "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", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + { + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + } + ] + }, + "MobNb": { + "allOf": [ + { + "title": "PhoneNumber", "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", + { + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + } + ] + }, + "FaxNb": { + "allOf": [ + { + "title": "PhoneNumber", "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + { + "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": 140, - "example": 12345 + "maxLength": 2048, + "example": 2048 }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + { + "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": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + { + "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": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "CtrySubDvsn": { + { + "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", @@ -62586,489 +59372,388 @@ "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": { + { + "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" } - }, - "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" + "Othr": { + "allOf": [ + { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "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" } - }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" + ] + } + }, + "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" + } } } }, - { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" } - ] - } - }, - "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": "Party\nIdentification of a person or an organisation.\n" } - } - }, - { - "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" + ] } + }, + "required": [ + "Pty" ] }, - "Cdtr": { - "allOf": [ - { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + { + "properties": { + "Agt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification18", "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ + "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", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "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" + ] }, { - "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" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" + ] } - ] - } - }, - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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" + ], + "example": { + "Cd": "CHIPS" + } }, { - "description": "AnyBIC\nBusiness identification code of the organisation.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "LEI": { + "MmbId": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - "Othr": { - "allOf": [ + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "GenericOrganisationIdentification3", - "type": "object", - "description": "Information related to an identification of an organisation.\n", "properties": { - "Id": { + "Cd": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "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", - "minLength": 1, - "maxLength": 256, - "example": 256 + "example": "ADDR" }, { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "SchmeNm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", + "title": "GenericIdentification30", "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification code.", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 4, + "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "Prtry": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -63079,464 +59764,982 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] - } - }, - "oneOf": [ - { - "properties": { - "Cd": {} - } }, - { - "properties": { - "Prtry": {} - } + "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": { - "Cd": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "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": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } + "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": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] - } - }, - "required": [ - "OrgId" - ] - }, - { - "properties": { - "PrvtId": { + }, + "Othr": { "allOf": [ { - "title": "PersonIdentification18", - "description": "Unique and unambiguous way to identify a person.\n", + "title": "GenericFinancialIdentification1", "type": "object", + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { - "DtAndPlcOfBirth": { + "Id": { "allOf": [ { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", + "title": "Max35Text", + "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", - "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" + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" ], "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" + "Cd": "BIC" } }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "Othr": { + "Issr": { "allOf": [ { - "title": "GenericPersonIdentification2", - "type": "object", - "description": "Identification of a person.", + "title": "Max35Text", + "description": "Specifies a character string with a 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", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { "properties": { - "Id": { + "Cd": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "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", - "minLength": 1, - "maxLength": 256, - "example": 256 + "example": "ADDR" }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "SchmeNm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", + "title": "GenericIdentification30", "type": "object", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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": [ - "Prtry" ] } + }, + "required": [ + "Id", + "Issr" ], "example": { - "Cd": "CCPT" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "Prtry" + ] } - ] - } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 + ], + "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": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, - "required": [ - "PrvtId" - ] - } - ], - "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "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" } - } - }, - { - "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" + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - { - "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" + "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" + } } - ] + } }, - "CtctDtls": { - "allOf": [ - { - "title": "Contact13", - "description": "Specifies the details of the contact person.\n", - "type": "object", - "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" + { + "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", + "anyOf": [ + { + "properties": { + "Pty": { + "allOf": [ + { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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", - "example": "DOCT" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "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", + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" - } - ] - }, - "PhneNb": { - "allOf": [ - { - "title": "PhoneNumber", + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" - } - ] - }, - "MobNb": { - "allOf": [ - { - "title": "PhoneNumber", + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 }, - { - "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" - } - ] - }, - "FaxNb": { - "allOf": [ - { - "title": "PhoneNumber", + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - { - "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", + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 2048, - "example": 2048 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "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", + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, - "maxLength": 256, - "example": 256 + "maxLength": 16, + "example": 1234567890123456 }, - { - "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" - } - ] - }, - "EmailPurp": { - "allOf": [ - { + "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", @@ -63544,14 +60747,7 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" - } - ] - }, - "JobTitl": { - "allOf": [ - { + "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -63559,14 +60755,7 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "JobTitle\nTitle of the function.\n" - } - ] - }, - "Rspnsblty": { - "allOf": [ - { + "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -63574,248 +60763,180 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Responsibility\nRole of a person in an organisation.\n" - } - ] - }, - "Dept": { - "allOf": [ - { + "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 - }, - { - "description": "Department\nIdentification of a division of a large organisation or building.\n" } - ] + }, + "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" + } }, - "Othr": { - "allOf": [ + { + "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", + "anyOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", - "type": "object", "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": { + "OrgId": { "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", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" - }, - { - "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", - "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 + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "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" + } + ] }, - { - "description": "Identification\nIdentification assigned by an institution.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "AccountSchemeName1Choice", - "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "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", + "description": "Information that locates and identifies an organisation.\n", "properties": { - "Cd": { + "Id": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "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", @@ -63826,104 +60947,410 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Prtry" - ] + "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": { - "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" + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" } - ] - } - }, - "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" + { + "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", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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", + "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", + "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" ] } - }, - "required": [ - "Othr" - ] + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + { + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } - ], - "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", - "oneOf": [ + "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", "properties": { - "Cd": { + "NmPrfx": { "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", + "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": 4, - "example": 1234 + "maxLength": 140, + "example": 12345 }, { - "description": "Code\nAccount type, in a coded form.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "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", @@ -63934,861 +61361,505 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + "description": "EmailPurpose\nPurpose for which an email address may be used.\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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ + }, + "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", "properties": { - "Cd": { + "ChanlTp": { "allOf": [ { - "title": "ExternalProxyAccountType1Code", - "description": "Specifies the external proxy account type code.", + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { - "description": "Code\nProxy account type, in a coded form as published in an external list.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 128, + "example": 12345 }, { - "description": "Proprietary\nProxy account type, in a proprietary form.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Prtry" - ] + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + { + "description": "Other\nContact details in another form.\n" } - ], - "example": { - "Cd": "EMAIL" - } + ] }, - { - "description": "Type\nType of the proxy identification.\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" + } }, - "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" - } - ] + { + "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\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", - "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 + }, + "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" }, - { - "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", - "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" + "Id": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Prtry": "DfspId" + } + } + } }, - { - "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" + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" } - ] + } }, - "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" - } - ] + { + "description": "Party\nIdentification of a person or an organisation.\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" + ] } + }, + "required": [ + "Pty" ] }, - "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", - "oneOf": [ - { - "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": { + "Agt": { + "allOf": [ { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "Prtry": { + "FinInstnId": { "allOf": [ { - "title": "Max35Text", - "description": "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", - "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", - "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", - "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 + "title": "FinancialInstitutionIdentification18", + "type": "object", + "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" + } + ] }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "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" + } + ] }, - { - "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" + "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" + } + ] } - ] - }, - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] + "MmbId": 123456789 + } + }, + { + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\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", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\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" }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + { + "description": "LEI\nLegal entity identifier of the financial institution.\n" } - }, - { - "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", + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, - "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", - "properties": { - "Cdtr": { - "allOf": [ - { - "title": "TaxParty1", - "description": "Details about the entity involved in the tax paid or to be paid.\n", - "type": "object", - "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", - "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": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + } + ] }, - { - "description": "TaxType\n\nType of tax payer.\n" - } - ] - }, - "Authstn": { - "allOf": [ - { - "title": "TaxAuthorisation1", - "description": "Details of an authorised tax paying party.\n", - "type": "object", - "properties": { - "Titl": { - "allOf": [ - { + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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", @@ -64796,115 +61867,39 @@ "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", + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "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", - "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", - "properties": { - "Titl": { - "allOf": [ - { + "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", @@ -64912,2540 +61907,2081 @@ "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", + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, - { - "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" + "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" } - }, - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + ] }, - { - "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" + "Othr": { + "allOf": [ + { + "title": "GenericFinancialIdentification1", + "type": "object", + "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", + "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" + } + ] } - ] - }, - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" }, - { - "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" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } - ] + } }, - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] + { + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\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", - "pattern": "^[\\d\\-\\.\\,]{1,18}$", - "example": 256 + ] }, - { - "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", - "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 + "BrnchId": { + "allOf": [ + { + "title": "BranchData3", + "type": "object", + "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" + } + ] }, - { - "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 + "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" + } + ] }, - { - "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 + "Nm": { + "allOf": [ + { + "title": "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" + } + ] }, - { - "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", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "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" + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "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" ] } - }, - "required": [ - "FrDt", - "ToDt" ], "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + "Cd": "ADDR" } }, - { - "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", + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "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", + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Year\n\nYear related to the tax payment.\n" + "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": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + }, + "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" } - } - }, - { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\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" + } + } }, - "TaxAmt": { - "allOf": [ + { + "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", + "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", + "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", + "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", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "TaxAmount3", - "description": "Information on the amount of the tax record.\n", - "type": "object", "properties": { - "Rate": { + "Cd": { "allOf": [ { - "title": "PercentageRate", + "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 + "example": "ADDR" }, { - "description": "Rate\n\nRate used to calculate the tax.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "TaxblBaseAmt": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "GenericIdentification30", "type": "object", - "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", + "description": "Generic scheme identification for a party.\n", "properties": { - "ActiveOrHistoricCurrencyAndAmount": { + "Id": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "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" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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": { + "Issr": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "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" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "Ccy": { + "SchmeNm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Amt" + "Id", + "Issr" ], "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "items": { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", - "type": "object", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, - "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" + "required": [ + "Prtry" + ] } - ] - } - }, - "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" + ], + "example": { + "Cd": "ADDR" } }, - "TaxAmt": { - "Rate": 0.2, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 1000 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 200 - } + "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 }, - "AddtlInf": "VAT applicable" - } - }, - { - "items": { - "title": "TaxRecord3", - "description": "Set of elements used to define the tax record.\n", - "type": "object", - "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", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "properties": { - "Rate": { - "allOf": [ - { - "title": "PercentageRate", - "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 - }, - { - "description": "Rate\n\nRate used to calculate the tax.\n" - } - ] - }, - "TaxblBaseAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } + "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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ + { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "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" }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + { + "description": "AnyBIC\nBusiness identification code of the organisation.\n" } - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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" - } - ] - } + ] + }, + "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" }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } + { + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } - }, - { - "items": { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericOrganisationIdentification1", "type": "object", + "description": "Information that locates and identifies an organisation.\n", "properties": { - "Prd": { + "Id": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "Max35Text", + "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", "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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": { + "Cd": { "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", + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", "type": "string", - "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "Type\n\nIdentification of the period related to the tax payment.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, - "Yr": { + "Prtry": { "allOf": [ { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Year\n\nYear related to the tax payment.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } } + ], + "example": { + "Cd": "BIC" } }, { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "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", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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", + "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" } ] }, - "Amt": { + "SchmeNm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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" + "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" ] }, - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Cd": "CCPT" } }, { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "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": [ - "Amt" + "Id" ], "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } + "Issr": "BIC" } }, - "type": "array" - } - ] - } - }, - "example": { - "Rate": 0, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 0 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 0 + { + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + } + ] + } }, - "Dtls": { - "Tp": "T1", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - "Inf": 12345 + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } } + }, + { + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } - }, - { - "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" + "required": [ + "PrvtId" + ] } - }, - "type": "array" + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + { + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] - } - }, - "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", - "oneOf": [ - { - "properties": { - "IlpV4PrepPacket": { + "CtryOfRes": { "allOf": [ { - "title": "hexBinary", + "title": "CountryCode", "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, 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": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\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" } ] - } - }, - "required": [ - "IlpV4PrepPacket" - ] - }, - { - "properties": { - "Sh256Sgntr": { + }, + "CtctDtls": { "allOf": [ { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", - "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" - }, - { - "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": [ - "MsgId", - "CreDtTm", - "NbOfTxs", - "SttlmInf", - "CdtTrfTxInf" - ], - "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 - } - }, - "CdtTrfTxInf": { - "PmtId": { - "InstrId": 123, - "EndToEndId": 123 - }, - "PmtTpInf": { - "InstrPrty": "NORM" - }, - "InstdAmt": { - "Amt": 123, - "Ccy": "EUR" - }, - "ChrgBr": "SLEV", - "CdtrAgt": { - "FinInstnId": { - "BICFI": 123 - } - }, - "Cdtr": { - "Nm": "John Doe" - }, - "CdtrAcct": { - "Id": { - "IBAN": 123 - } - }, - "RmtInf": { - "Ustrd": "Test" - } - } - } - }, - { - "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", - "properties": { - "PmtId": { - "allOf": [ - { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", - "type": "object", - "properties": { - "InstrId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "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", - "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", - "oneOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "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" + } + ] }, - { - "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 + "Nm": { + "allOf": [ + { + "title": "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" + } + ] }, - { - "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\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", + "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": [ - "Prtry" ] } + }, + "required": [ + "Id" ], "example": { - "Cd": "SEPA" - } - }, - { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" - } - ] - }, - "LclInstrm": { - "allOf": [ - { - "title": "LocalInstrument2Choice", - "type": "object", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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" - ] + "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" }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "Id": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Prtry": "DfspId" + } } - }, - "required": [ - "Prtry" - ] + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" } - ], - "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" + "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, - "CtgyPurp": { + "Acct": { "allOf": [ { - "title": "CategoryPurpose1Choice", - "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "title": "CashAccount40", "type": "object", - "oneOf": [ - { - "properties": { - "Cd": { - "allOf": [ + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "anyOf": [ { - "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 + "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" + ] }, { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "properties": { + "Othr": { + "allOf": [ + { + "title": "GenericAccountIdentification1", + "type": "object", + "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", + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "Tp": { + "allOf": [ + { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "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 + "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" + ] }, { - "description": "Proprietary\nCategory purpose, in a proprietary form.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" } - }, - "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" - } - ] - }, - "IntrBkSttlmAmt": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "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", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "pattern": "^[A-Z]{3,3}$", - "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\".", - "example": "USD" - }, - { - "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "description": "Information used to identify a financial institution.\n", - "properties": { - "BICFI": { + }, + "Ccy": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "title": "ActiveOrHistoricCurrencyCode", "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": "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" }, { - "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" + "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" } ] }, - "ClrSysMmbId": { + "Nm": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "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", "properties": { - "ClrSysId": { + "Tp": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, - "maxLength": 5, - "example": 12345 + "maxLength": 4, + "example": 1234 }, { - "description": "Code\nClearing system identification code, as published in an external list.\n" + "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } @@ -67467,7 +64003,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } @@ -67478,59 +64014,1048 @@ } ], "example": { - "Cd": "CHIPS" + "Cd": "EMAIL" } }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "Type\nType of the proxy identification.\n" } ] }, - "MmbId": { + "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 2048, + "example": 2048 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ - "MmbId" + "Id" ], "example": { - "ClrSysId": { - "Cd": "CHQB" + "Tp": { + "Cd": "IBAN" }, - "MmbId": 123456789 + "Id": 123 } }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" }, - "LEI": { + "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", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { "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" - } - ] + "title": "FinancialInstitutionIdentification18", + "type": "object", + "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", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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", + "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", + "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", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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", + "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", + "properties": { "Nm": { "allOf": [ { @@ -67542,7 +65067,7 @@ "example": 12345 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, @@ -67557,7 +65082,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -67808,90 +65333,546 @@ } ] }, - "Othr": { + "Id": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "Party38Choice", + "description": "Nature or use of the account.\n", "type": "object", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", "properties": { - "Cd": { + "AnyBIC": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", + "title": "AnyBICDec2014Identifier", "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "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": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] - } - }, - "required": [ - "Cd" - ] + }, + "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", + "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", + "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", "properties": { - "Prtry": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericPersonIdentification1", + "type": "object", + "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", + "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" } ] } }, - "required": [ - "Prtry" - ] + "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", + "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" ], - "example": { - "Cd": "BIC" - } + "type": "string", + "example": "DOCT" }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, - "Issr": { + "Nm": { + "allOf": [ + { + "title": "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", @@ -67902,525 +65883,754 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "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", + "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" } ] } }, - "required": [ - "Id" - ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" } }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, - "required": [], + "required": [ + "Id" + ], "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 - }, - "LEI": 123, - "Nm": "Name", + "Nm": "John Doe", "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" + "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" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, - "BrnchId": { + "Acct": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "CashAccount40", "type": "object", + "description": "Provides the details to identify an account.\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 + "title": "AccountIdentification4Choice", + "type": "object", + "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", + "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", + "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 of a branch of a financial institution.\n" + "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, - "LEI": { + "Tp": { "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", + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "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", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" }, { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" + "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": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + "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" } ] }, - "PstlAdr": { + "Prxy": { "allOf": [ { - "title": "PostalAddress27", + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "Tp": { + "allOf": [ { - "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" + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", + "type": "object", + "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" ] } - }, - "required": [ - "Cd" - ] + ], + "example": { + "Cd": "EMAIL" + } }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "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" - ] + "description": "Type\nType of the proxy identification.\n" } - ], - "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 + "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": { - "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" + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 } } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Account\nUnambiguous identification of the account of a party.\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", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { + "Agt": { "allOf": [ { - "title": "AccountIdentification4Choice", + "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "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" + } + ] }, - { - "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", - "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 + "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", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "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" + } + ] }, - { - "description": "Identification\nIdentification assigned by an institution.\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 + } }, - "SchmeNm": { - "allOf": [ - { - "title": "AccountSchemeName1Choice", + { + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "description": "Choice of formats for the type of address.\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", + "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", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "example": "ADDR" }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Code\nType of address expressed as a code.\n" } ] } @@ -68434,15 +66644,67 @@ "Prtry": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "GenericIdentification30", + "type": "object", + "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\nName of the identification scheme, in a free text form.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } @@ -68453,17 +66715,42 @@ } ], "example": { - "Cd": 1111 + "Cd": "ADDR" } }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { + "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", @@ -68471,174 +66758,39 @@ "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", - "oneOf": [ - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalProxyAccountType1Code", - "description": "Specifies the external proxy account type code.", + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Code\nProxy account type, in a coded form as published in an external list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "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", @@ -68646,501 +66798,228 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Proprietary\nProxy account type, in a proprietary form.\n" + "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" } - }, - "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { + }, + "Othr": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "title": "GenericFinancialIdentification1", "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { - "Cd": { + "Id": { "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" - ], + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "example": "ADDR" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "SchmeNm": { "allOf": [ { - "title": "GenericIdentification30", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "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" + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "Id", - "Issr" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Cd": "BIC" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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": [ - "Prtry" - ] + "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" } - ], - "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 + ] } }, + "required": [], "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" + "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, - "Othr": { + "BrnchId": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "BranchData3", "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ @@ -69153,1127 +67032,1379 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "SchmeNm": { + "LEI": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } + "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": "SchemeName\nName of the identification scheme.\n" + "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, - "Issr": { + "Nm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - ] - }, + "PstlAdr": { + "allOf": [ { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Prtry": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "example": "ADDR" }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "SchmeNm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "GenericIdentification30", + "type": "object", + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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 } }, - "required": [ - "Prtry" - ] + "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": { - "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" + "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "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": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" + "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": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Agent\nFinancial institution servicing an account for a party.\n" } ] } }, "required": [ - "FinInstnId" + "Pty" ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" }, - "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" + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" } } } }, { - "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" + "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n" + } + ] + } + }, + "required": [ + "OrgnlId", + "Vrfctn", + "UpdtdPtyAndAcctId" + ], + "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", + "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" } ] }, - "CdtrAgt": { + "Envlp": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "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" + }, + { + "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", + "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", + "format": "datetime", + "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", + "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", + "pattern": "^[A-Z]{3,3}$", + "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\".", + "example": "USD" + }, + { + "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", + "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", + "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", + "anyOf": [ { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "description": "Information used to identify a financial institution.\n", "properties": { - "BICFI": { + "Cd": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "title": "ExternalServiceLevel1Code", + "description": "Specifies the external service level code.", "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" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "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" + "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] - }, - "ClrSysMmbId": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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 - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] - }, - "LEI": { + } + }, + "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", + "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": "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", + "title": "ExternalLocalInstrument1Code", + "description": "Specifies the external local instrument identification code.", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 35, + "example": 12345 }, { - "description": "LEI\nLegal entity identifier of the financial institution.\n" + "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] - }, - "Nm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] - }, - "PstlAdr": { + } + }, + "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", + "anyOf": [ + { + "properties": { + "Cd": { "allOf": [ { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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": "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] - }, - "Othr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "GenericFinancialIdentification1", - "type": "object", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 + "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", + "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalServiceLevel1Code", + "description": "Specifies the external service level code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, - "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" + { + "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 }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + { + "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\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", + "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" ] }, - "BrnchId": { + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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", + "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", + "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", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "CreationDateTime\nDate and time at which the message was created.\n" + } + ] + }, + "TxInfAndSts": { + "allOf": [ + { + "title": "PaymentTransaction163", + "description": "Provides further details on the original transactions, to which the status report message refers.\n", + "type": "object", + "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.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Specifies the status of the transaction.\n" + } + ] + }, + "StsRsnInf": { + "allOf": [ + { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Orgtr": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "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": [ { @@ -70285,7 +68416,7 @@ "example": 12345 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, @@ -70300,7 +68431,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -70565,486 +68696,565 @@ } }, { - "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "ClrSysMmbId": { + "Id": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", "properties": { - "Cd": { + "AnyBIC": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "title": "AnyBICDec2014Identifier", "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "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": "Code\nClearing system identification code, as published in an external list.\n" + "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "LEI": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "LEI\nLegal entity identification as an alternate identification for a party.\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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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 + "Othr": { + "allOf": [ + { + "title": "GenericOrganisationIdentification3", + "type": "object", + "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" + } + ] }, - { - "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 + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "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" + } + ] }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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 + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\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": [ - "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" + }, + "required": [ + "OrgId" + ] }, - "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 + { + "properties": { + "PrvtId": { + "allOf": [ + { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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", + "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", + "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": { - "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" + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, - "Othr": { + "CtryOfRes": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, 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", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { - "Id": { + "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", @@ -71055,731 +69265,229 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, - "SchmeNm": { + "JobTitl": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "Max35Text", + "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "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": [ - "Prtry" ] } + }, + "required": [ + "ChanlTp" ], "example": { - "Cd": "BIC" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "OtherContact\nContact details in another form.\n" } ] }, - "Issr": { + "PrefrdMtd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, - "required": [ - "Id" - ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "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": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, - "required": [], + "required": [ + "Id" + ], "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 - }, - "LEI": 123, - "Nm": "Name", + "Nm": "John Doe", "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" + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 + "Id": { + "OrgId": { + "AnyBIC": "BIC" }, - "Issr": 123 + "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "Originator\nParty that issues the status.\n" } ] }, - "BrnchId": { + "Rsn": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalStatusReason1Code", + "description": "Specifies the external status reason code.", "type": "string", "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 + "maxLength": 4, + "example": 1234 }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + { + "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": 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", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" - }, - { - "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", - "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", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + "description": "Proprietary\nReason for the status, in a proprietary form.\n" } ] } @@ -71790,1086 +69498,639 @@ } ], "example": { - "Cd": "CACC" + "Cd": "AGNT" } }, { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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" + "description": "Reason\nSpecifies the reason for the status report.\n" } ] }, - "Nm": { + "AddtlInf": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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 - } + "maxLength": 105, + "example": 12345 }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "AdditionalInformation\nAdditional information about the status report.\n" } ] } }, "example": { - "Id": { - "IBAN": "BE71096123456769" + "Orgtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "SubDepartment", + "StrtNm": "StreetName", + "BldgNb": "BuildingNumber", + "PstCd": "PostCode", + "TwnNm": "TownName", + "CtrySubDvsn": "CountrySubDivision", + "Ctry": "Country" + } }, - "Tp": { - "Cd": "CACC" + "Rsn": { + "Cd": "AGNT" }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 - } + "AddtlInf": "AdditionalInformation" } }, { - "description": "CreditorAccount\nAccount to which a credit entry is made.\n" + "description": "Information concerning the reason for the status.\n" } ] }, - "InstrForCdtrAgt": { + "AccptncDtTm": { "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", - "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." - } + "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", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" }, { - "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" + "description": "Date and time at which the status was accepted.\n" } ] }, - "Purp": { + "AcctSvcrRef": { "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", - "oneOf": [ - { - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Purpose\nUnderlying reason for the payment transaction.\n" + "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" } ] }, - "VrfctnOfTerms": { + "ClrSysRef": { "allOf": [ { - "title": "CryptographicLockChoice", - "description": "Cryptographically signed terms\n", + "title": "Max35Text", + "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 with a length of 32 characters.\n", + "type": "string", + "example": "1234567890ABCDEF1234567890ABCDEF" + }, + { + "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", - "oneOf": [ - { - "properties": { - "IlpV4PrepPacket": { - "allOf": [ - { - "title": "hexBinary", - "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 - }, - { - "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" - } - ] + "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" } - }, - "required": [ - "IlpV4PrepPacket" ] }, - { - "properties": { - "Sh256Sgntr": { - "allOf": [ - { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", - "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" - }, - { - "description": "SHA-256 signature of the terms\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" + }, + { + "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": [ - "Sh256Sgntr" ] } + }, + "required": [ + "Envlp" ], "example": { - "IlpV4PrepPacket": "1234567890ABCDEF" + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } } }, { - "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" + "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\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" + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" }, - "VrfctnOfTerms": { - "Cntt": "CONTENT", - "CnttTp": "PROPRIETARY" + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" } } }, { - "description": "CreditTransferTransactionInformation.\nSet of elements providing information specific to the individual credit transfer(s).\n" + "description": "TransactionInformationAndStatus\nDefinition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).\nUsage: The instructing agent is the party sending the status message and not the party that sent the original instruction that is being reported on.\n" } ] } }, "required": [ - "GrpHdr", - "CdtTrfTxInf" + "MsgId", + "CreDtTm" ], "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": "SLEV", - "CdtrAgt": { - "FinInstnId": { - "BICFI": "CCCCCCCC" - } - }, - "Cdtr": { - "Nm": "Creditor Name" - }, - "CdtrAcct": { - "Id": { - "IBAN": "BE71096123456769" - } + "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" }, - "RmtInf": { - "Ustrd": "Payment for invoice 12345" + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" } } } }, - "GenericAccountIdentification1": { - "title": "GenericAccountIdentification1", + "GroupHeader129": { + "title": "GroupHeader129", + "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { - "Id": { + "MsgId": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Message Identification\n" } ] }, - "SchmeNm": { + "CreDtTm": { "allOf": [ { - "title": "AccountSchemeName1Choice", - "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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 - } + "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", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Creation Date and Time\n" } ] }, - "Issr": { + "PmtInstrXpryDtTm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Payment Instruction Expiry Date and Time\n" } ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" }, - "Issr": "BIC" - } - }, - "GenericFinancialIdentification1": { - "title": "GenericFinancialIdentification1", - "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", - "properties": { - "Id": { + "NbOfTxs": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Number of Transactions\n" } ] }, - "SchmeNm": { + "SttlmInf": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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": { + "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" }, - { - "properties": { - "Prtry": { + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "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": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "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": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" + } + ] + }, + "LclInstrm": { + "allOf": [ + { + "title": "LocalInstrument2Choice", + "type": "object", + "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", + "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" } ] } }, - "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", - "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", - "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", - "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", - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" }, - { - "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 + "LclInstrm": { + "Cd": "CORE" }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "CtgyPurp": { + "Cd": "CASH" } - ] - } - }, - "oneOf": [ - { - "properties": { - "Cd": {} - } - }, - { - "properties": { - "Prtry": {} } } + }, + "required": [ + "SttlmMtd" ], "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", - "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", - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "SttlmMtd": "INDA", + "PmtTpInf": { + "InstrPrty": "NORM", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CH03" + }, + "CtgyPurp": { + "Cd": "SUPP" + }, + "Cdtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "AdrLine": "Address", + "Ctry": "CH" }, - { - "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 + "Id": { + "OrgId": { + "AnyBIC": "BIC", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN", + "Issr": "BIC" + } + } + } }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "CtryOfRes": "CH", + "CtctDtls": { + "Nm": "Name", + "PhneNb": 123, + "EmailAdr": null } - ] - } - }, - "oneOf": [ - { - "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" + "description": "Settlement Information\n" } ] } }, "required": [ - "Id" + "MsgId", + "CreDtTm", + "NbOfTxs", + "SttlmInf" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" + "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 + } + } } }, - "GenericPersonIdentification1": { - "title": "GenericPersonIdentification1", + "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", + "format": "datetime", + "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", - "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", + "description": "IdentificationAssignment\nInformation that unambiguously identifies a message, as assigned by the assignor to the assignee.\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", - "oneOf": [ - { - "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": { + "MsgId": { "allOf": [ { "title": "Max35Text", @@ -72880,589 +70141,406 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "MessageIdentification\nUnique identification, as assigned by the assigner, to unambiguously identify the message.\n" } ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" }, - "Issr": "BIC" - } - }, - "GenericPersonIdentification2": { - "title": "GenericPersonIdentification2", - "type": "object", - "description": "Identification of a person.", - "properties": { - "Id": { + "CreDtTm": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "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", - "minLength": 1, - "maxLength": 256, - "example": 256 + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "CreationDateTime\nDate and time at which the identification assignment was created.\n" } ] }, - "SchmeNm": { + "Assgnr": { "allOf": [ { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", + "title": "Party40Choice", + "description": "Identification of a person, an organisation or a financial institution.\n", "type": "object", - "oneOf": [ - { - "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" - ] - }, + "anyOf": [ { "properties": { - "Prtry": { + "Pty": { "allOf": [ { - "title": "Max35Text", - "description": "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", - "properties": { - "Assgnmt": { - "allOf": [ - { - "title": "IdentificationAssignment3", - "type": "object", - "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", - "format": "datetime", - "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", - "oneOf": [ - { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", "properties": { - "Pty": { + "Nm": { "allOf": [ { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Nm": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "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" + ] }, { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "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" - ], + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "example": "ADDR" + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "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": [ - "Cd" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "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" - ] + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - ], - "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" + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "Id": { - "allOf": [ - { - "title": "Party38Choice", - "description": "Nature or use of the account.\n", - "type": "object", - "oneOf": [ + "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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", "properties": { - "OrgId": { + "AnyBIC": { "allOf": [ { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", + "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", + "description": "Information that locates and identifies an organisation.\n", "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": { + "Id": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, - "Othr": { + "SchmeNm": { "allOf": [ { - "title": "GenericOrganisationIdentification1", + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", "type": "object", - "description": "Information that locates and identifies an organisation.\n", "properties": { - "Id": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "properties": { - "Cd": {} - } - }, - { - "properties": { - "Prtry": {} - } - } - ], - "example": { - "Cd": "BIC" - } + "maxLength": 4, + "example": 1234 }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, - "Issr": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -73473,410 +70551,746 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, - "required": [ - "Id" + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" + "Cd": "BIC" } }, { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + "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": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" } }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "OrgId" - ] + "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", "properties": { - "PrvtId": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "PersonIdentification13", - "description": "Unique and unambiguous way to identify a person.\n", + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", "type": "object", "properties": { - "DtAndPlcOfBirth": { + "BirthDt": { "allOf": [ { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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" - } + "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": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + "description": "BirthDate\nDate on which a person was born.\n" } ] }, - "Othr": { + "PrvcOfBirth": { "allOf": [ { - "title": "GenericPersonIdentification1", + "title": "Max35Text", + "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", + "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", - "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", - "oneOf": [ + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ { - "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" - ] + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } - ], - "example": { - "Cd": "CCPT" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" + ] } + }, + "required": [ + "Cd" ] }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "Id" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" + "Cd": "CCPT" } }, { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "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": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } + "Issr": "BIC" } }, { - "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "PrvtId" - ] - } - ], - "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "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" } - } - }, - { - "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" + ] } + }, + "required": [ + "PrvtId" ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" }, - "CtctDtls": { - "allOf": [ - { - "title": "Contact4", - "description": "Specifies the details of the contact person.\n", - "type": "object", - "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": { + "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", + "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", + "properties": { + "ChanlTp": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 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}$" + "maxLength": 4, + "example": 1234 }, { - "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "FaxNb": { + "Id": { "allOf": [ { - "title": "PhoneNumber", + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + "minLength": 1, + "maxLength": 128, + "example": 12345 }, { - "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] - }, - "EmailAdr": { + } + }, + "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", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "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", + "properties": { + "ClrSysId": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "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": "EmailAddress\nAddress for electronic mail (e-mail).\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "EmailPurp": { + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -73887,26 +71301,325 @@ "example": 1.234567890123457e+34 }, { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - "JobTitl": { - "allOf": [ + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\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 + "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" + ] }, { - "description": "JobTitle\nTitle of the function.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "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" + } }, - "Rspnsblty": { + "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", + "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", @@ -73917,1167 +71630,176 @@ "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" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Othr": { + "SchmeNm": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "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" + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "ChanlTp" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Cd": "BIC" } }, { - "description": "Other\nContact details in another form.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "PrefrdMtd": { + "Issr": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "CELL" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "PreferredMethod\nPreferred method used to reach the contact.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Id" - ], + "required": [], "example": { - "Nm": "John Doe", + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 + }, + "LEI": 123, + "Nm": "Name", "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" - } - } - } + "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" }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "Party\nIdentification of a person or an organisation.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] - } - }, - "required": [ - "Pty" - ] - }, - { - "properties": { - "Agt": { + }, + "BrnchId": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification6", + "title": "BranchData3", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { - "FinInstnId": { + "Id": { "allOf": [ { - "title": "FinancialInstitutionIdentification18", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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 - } - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "BrnchId": { + "LEI": { "allOf": [ { - "title": "BranchData3", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" - } - } + "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": "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" + "description": "Legal Entity Identifier\nLegal entity identification for the branch of the 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\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", - "oneOf": [ - { - "properties": { - "Pty": { - "allOf": [ - { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "properties": { "Nm": { "allOf": [ { @@ -75089,7 +71811,7 @@ "example": 12345 }, { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, @@ -75104,7 +71826,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -75351,136 +72073,492 @@ } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Postal Address\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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "properties": { - "Cd": {} - } - }, - { - "properties": { - "Prtry": {} - } - } - ], - "example": { - "Cd": "BIC" - } + } + }, + "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", + "anyOf": [ + { + "properties": { + "Pty": { + "allOf": [ + { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ + { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "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", + "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", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, - "Issr": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -75491,410 +72569,746 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, - "required": [ - "Id" + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" + "Cd": "BIC" } }, { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + "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": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" } }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "OrgId" - ] + "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", "properties": { - "PrvtId": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "PersonIdentification13", - "description": "Unique and unambiguous way to identify a person.\n", + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", "type": "object", "properties": { - "DtAndPlcOfBirth": { + "BirthDt": { "allOf": [ { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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" - } + "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": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + "description": "BirthDate\nDate on which a person was born.\n" } ] }, - "Othr": { + "PrvcOfBirth": { "allOf": [ { - "title": "GenericPersonIdentification1", + "title": "Max35Text", + "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", + "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", - "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", - "oneOf": [ + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ { - "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" - ] + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } - ], - "example": { - "Cd": "CCPT" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" + ] } + }, + "required": [ + "Cd" ] }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "Id" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" + "Cd": "CCPT" } }, { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "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": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } + "Issr": "BIC" } }, { - "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "PrvtId" - ] - } - ], - "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "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" } - } - }, - { - "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" + ] } + }, + "required": [ + "PrvtId" ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" }, - "CtctDtls": { - "allOf": [ - { - "title": "Contact4", - "description": "Specifies the details of the contact person.\n", - "type": "object", - "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": { + "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", + "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", + "properties": { + "ChanlTp": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 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}$" + "maxLength": 4, + "example": 1234 }, { - "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "FaxNb": { + "Id": { "allOf": [ { - "title": "PhoneNumber", + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + "minLength": 1, + "maxLength": 128, + "example": 12345 }, { - "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] - }, - "EmailAdr": { + } + }, + "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", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "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", + "properties": { + "ClrSysId": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "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": "EmailAddress\nAddress for electronic mail (e-mail).\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "EmailPurp": { + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -75905,26 +73319,325 @@ "example": 1.234567890123457e+34 }, { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - "JobTitl": { - "allOf": [ + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\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 + "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" + ] }, { - "description": "JobTitle\nTitle of the function.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "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" + } }, - "Rspnsblty": { + "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", + "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", @@ -75935,265 +73648,965 @@ "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" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Othr": { + "SchmeNm": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "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" + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "ChanlTp" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Cd": "BIC" } }, { - "description": "Other\nContact details in another form.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "PrefrdMtd": { + "Issr": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "CELL" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "PreferredMethod\nPreferred method used to reach the contact.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Id" - ], + "required": [], "example": { - "Nm": "John Doe", + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 + }, + "LEI": 123, + "Nm": "Name", "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" - } - } - } + "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" }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "Party\nIdentification of a person or an organisation.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] - } - }, - "required": [ - "Pty" - ] - }, - { - "properties": { - "Agt": { + }, + "BrnchId": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification6", + "title": "BranchData3", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { - "FinInstnId": { + "Id": { "allOf": [ { - "title": "FinancialInstitutionIdentification18", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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" - } - ] + "title": "Max35Text", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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": [ - "Prtry" ] } + }, + "required": [ + "Id", + "Issr" ], "example": { - "Cd": "CHIPS" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "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", + "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", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ + { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "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", + "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", + "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" } ] }, - "MmbId": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -76204,477 +74617,263 @@ "example": 1.234567890123457e+34 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, - "required": [ - "MmbId" + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Cd": "BIC" } }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "LEI": { + "Issr": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "LEI\nLegal entity identifier of the financial institution.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" }, - "Nm": { + "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", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, - "PstlAdr": { + "CityOfBirth": { "allOf": [ { - "title": "PostalAddress24", + "title": "Max35Text", + "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", + "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" - } - ] + "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": [ - "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", - "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" - } + }, + "required": [ + "Cd" ] }, - "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + { + "properties": { + "Prtry": { + "allOf": [ { - "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" - ] + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } - ], - "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": [ + "Prtry" ] } - }, - "required": [ - "Id" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "Cd": "CCPT" } }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "SchemeName\nName of the 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", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "properties": { - "Id": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -76685,596 +74884,455 @@ "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, + "required": [ + "Id" + ], "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" - } + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" } }, { - "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" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "FinInstnId" - ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - "BrnchId": { + "Othr": { "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" + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 } } } }, { - "description": "Agent\nIdentification of a financial institution.\n" + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ - "Agt" + "PrvtId" ] } ], "example": { - "Pty": { - "Nm": "Name", - "PstlAdr": { - "Ctry": "US", - "AdrLine": [ - "Line1", - "Line2" - ] - }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - } - } + "OrgId": { + "AnyBIC": "BIC" }, - "Agt": { - "FinInstnId": { - "BICFI": "BUKBGB22" - }, - "BrnchId": { - "Id": 12345, - "Nm": "Oxford Street Branch", - "PstlAdr": { - "Ctry": "GB", - "AdrLine": [ - "1 Oxford Street", - "London", - "UK" - ] - } + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" } } } }, { - "description": "Assignee\nParty that the identification assignment is assigned to. This is also the receiver of the message.\n" + "description": "Identification\nUnique and unambiguous way to identify an organisation.\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", - "description": "VerificationReport\nProvides information about the verification of party and/or account identification information.", - "properties": { - "OrgnlId": { + "CtryOfRes": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "CountryCode", "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" + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, 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": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\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" } ] }, - "Rsn": { + "CtctDtls": { "allOf": [ { - "title": "VerificationReason1Choice", + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", "type": "object", - "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "Nm": { + "allOf": [ + { + "title": "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" } - }, - "required": [ - "Prtry" ] - } - ], - "example": { - "Cd": "AGNT" - } - }, - { - "description": "Reason\nSpecifies the reason why the verified identification information is incorrect.\n" - } - ] - }, - "OrgnlPtyAndAcctId": { - "allOf": [ - { - "title": "IdentificationInformation4", - "type": "object", - "description": "Information that locates and identifies a specific party or account.\n", - "properties": { - "Pty": { + }, + "PhneNb": { "allOf": [ { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" + "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", + "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", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "AccountIdentification4Choice", + "type": "object", + "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", + "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", + "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" } ] } @@ -77288,67 +75346,15 @@ "Prtry": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -77359,90 +75365,17 @@ } ], "example": { - "Cd": "ADDR" + "Cd": 1111 } }, - "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": { + { + "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", @@ -77450,15 +75383,174 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + { + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "Tp": { + "allOf": [ + { + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 4, + "example": 1234 }, - "CtrySubDvsn": { + { + "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", @@ -77466,969 +75558,538 @@ "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 + { + "description": "Proprietary\nProxy account type, in a proprietary form.\n" } - }, - "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" + ] } + }, + "required": [ + "Prtry" ] - }, - "Id": { + } + ], + "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", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "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", + "properties": { + "ClrSysId": { "allOf": [ { - "title": "Party38Choice", - "description": "Nature or use of the account.\n", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { - "OrgId": { + "Cd": { "allOf": [ { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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" - } - } + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ - "OrgId" + "Cd" ] }, { "properties": { - "PrvtId": { + "Prtry": { "allOf": [ { - "title": "PersonIdentification13", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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 - } - } - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ - "PrvtId" + "Prtry" ] } ], "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } + "Cd": "CHIPS" } }, { - "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "CtryOfRes": { + "MmbId": { "allOf": [ { - "title": "CountryCode", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "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" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - "CtctDtls": { - "allOf": [ + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Contact4", - "description": "Specifies the details of the contact person.\n", - "type": "object", "properties": { - "NmPrfx": { + "Cd": { "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", + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ - "DOCT", - "MADM", - "MISS", - "MIST", - "MIKS" + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" ], "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 + "example": "ADDR" }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "Othr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "GenericIdentification30", "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "ChanlTp": { + "Id": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 4, + "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "Id": { + "Issr": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 128, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "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": [ - "ChanlTp" + "Id", + "Issr" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" - } + "required": [ + "Prtry" + ] } + ], + "example": { + "Cd": "ADDR" } }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "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": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "Acct": { + "Othr": { "allOf": [ { - "title": "CashAccount40", + "title": "GenericFinancialIdentification1", "type": "object", - "description": "Provides the details to identify an account.\n", + "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": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" - }, - { - "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", - "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", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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" - } + "title": "Max35Text", + "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 for the account between the account owner and the account servicer.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Tp": { + "SchmeNm": { "allOf": [ { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "oneOf": [ + "description": "Specifies the name of the identification scheme.\n", + "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", + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { - "description": "Code\nAccount type, in a coded form.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } @@ -78450,7 +76111,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -78461,588 +76122,197 @@ } ], "example": { - "Cd": "CACC" + "Cd": "BIC" } }, { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "Nm": { + "Issr": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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 - } + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 - } + "Issr": "BIC" } }, { - "description": "Account\nUnambiguous identification of the account of a party.\n" + "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 }, - "Agt": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification6", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification18", - "type": "object", - "description": "Information used to identify a financial institution.\n", + "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", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { "properties": { - "BICFI": { + "Cd": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "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", - "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" + "example": "ADDR" }, { - "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" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "ClrSysMmbId": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "GenericIdentification30", "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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": { + "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", - "properties": { - "Id": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -79053,72 +76323,11 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", @@ -79129,1677 +76338,2168 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Id" + "Id", + "Issr" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "BrnchId": { - "allOf": [ - { - "title": "BranchData3", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" + "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 }, - "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" - } + "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", + "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." + } + }, + "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", + "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", + "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", + "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", + "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", + "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" + } + ] }, - "Agt": { - "FinInstnId": { - "BICFI": "BICFI" + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "UpdtdPtyAndAcctId": { + "Issr": { "allOf": [ { - "title": "IdentificationInformation4", + "title": "Max35Text", + "description": "Specifies a character string with a 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", + "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", + "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", - "description": "Information that locates and identifies a specific party or account.\n", "properties": { - "Pty": { + "Cd": { "allOf": [ { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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" + "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", + "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", + "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", + "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", + "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", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "CreationDateTime\nDate and time at which the message was created.\n" + } + ] + }, + "TxInfAndSts": { + "allOf": [ + { + "title": "PaymentTransaction163", + "description": "Provides further details on the original transactions, to which the status report message refers.\n", + "type": "object", + "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.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Specifies the status of the transaction.\n" + } + ] + }, + "StsRsnInf": { + "allOf": [ + { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Orgtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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" ] }, - "Othr": { - "allOf": [ - { - "title": "GenericOrganisationIdentification1", - "type": "object", - "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", - "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" - } - ] + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "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 }, - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } - }, - "oneOf": [ + ] + }, + "Issr": { + "allOf": [ { - "properties": { - "Cd": {} - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "properties": { - "Prtry": {} - } + "description": "Issuer\nEntity that assigns the identification.\n" } - ], - "example": { - "Cd": "BIC" - } + ] }, - { - "description": "SchemeName\nName of the identification scheme.\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" + } }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] + { + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + ] } + }, + "required": [ + "Prtry" ] } - }, + ], "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } + "Cd": "ADDR" } }, - { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "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" } - }, - "required": [ - "OrgId" ] }, - { - "properties": { - "PrvtId": { - "allOf": [ + "Id": { + "allOf": [ + { + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", + "type": "object", + "anyOf": [ { - "title": "PersonIdentification13", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", "properties": { - "DtAndPlcOfBirth": { + "OrgId": { "allOf": [ { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "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": { + "AnyBIC": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "AnyBICDec2014Identifier", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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": "CityOfBirth\nCity where a person was born.\n" + "description": "AnyBIC\nBusiness identification code of the organisation.\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", - "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", - "properties": { - "Id": { + "LEI": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, - "SchmeNm": { + "Othr": { "allOf": [ { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", + "title": "GenericOrganisationIdentification3", "type": "object", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "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": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "properties": { + "Cd": {} + } }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "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": [ - "Prtry" ] } + }, + "required": [ + "Id" ], "example": { - "Cd": "CCPT" + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "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" + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Id" - ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } } }, { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } - } + "required": [ + "OrgId" + ] }, { - "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" + "properties": { + "PrvtId": { + "allOf": [ + { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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", + "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", + "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" + ] } - ] - } - }, - "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", - "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 + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, - "Dept": { + "CtryOfRes": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "CountryCode", "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, 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": "Department\nIdentification of a division of a large organisation or building.\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" } ] }, - "Othr": { + "CtctDtls": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", "type": "object", "properties": { - "ChanlTp": { + "NmPrfx": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", + "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", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "example": "DOCT" }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, - "Id": { + "Nm": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 128, + "maxLength": 140, "example": 12345 }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\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", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" }, - { - "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", - "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" - } - ] + "PhneNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "SchmeNm": { - "allOf": [ - { - "title": "AccountSchemeName1Choice", - "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + { + "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", + "properties": { + "ChanlTp": { + "allOf": [ { - "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" - ] + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } - ], - "example": { - "Cd": 1111 - } + ] }, - { - "description": "SchemeName\nName of the identification scheme.\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 + } }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] + { + "description": "OtherContact\nContact details in another form.\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" + "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": [ - "Othr" ] } + }, + "required": [ + "Id" ], "example": { - "IBAN": "BE71096123456769" + "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": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" + "description": "Originator\nParty that issues the status.\n" } ] }, - "Tp": { + "Rsn": { "allOf": [ { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", "type": "object", - "oneOf": [ + "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", + "title": "ExternalStatusReason1Code", + "description": "Specifies the external status reason code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { - "description": "Code\nAccount type, in a coded form.\n" + "description": "Code\nReason for the status, as published in an external reason code list.\n" } ] } @@ -80821,7 +78521,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + "description": "Proprietary\nReason for the status, in a proprietary form.\n" } ] } @@ -80832,1449 +78532,841 @@ } ], "example": { - "Cd": "CACC" + "Cd": "AGNT" } }, { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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" + "description": "Reason\nSpecifies the reason for the status report.\n" } ] }, - "Nm": { + "AddtlInf": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "maxLength": 105, + "example": 12345 }, { - "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" + "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" + } }, - "Prxy": { - "allOf": [ - { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", - "type": "object", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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 - } + "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", + "format": "datetime", + "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 with a length of 32 characters.\n", + "type": "string", + "example": "1234567890ABCDEF1234567890ABCDEF" + }, + { + "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", + "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": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "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" + }, + { + "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": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" - }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" } } }, { - "description": "Account\nUnambiguous identification of the account of a party.\n" + "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" } ] + } + }, + "example": { + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" }, - "Agt": { + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" + } + } + }, + { + "description": "TransactionInformationAndStatus\nDefinition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).\nUsage: The instructing agent is the party sending the status message and not the party that sent the original instruction that is being reported on.\n" + } + ] + } + }, + "required": [ + "MsgId", + "CreDtTm" + ], + "example": { + "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" + } + } + } + }, + { + "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", + "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.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Specifies the status of the transaction.\n" + } + ] + }, + "StsRsnInf": { + "allOf": [ + { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Orgtr": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification6", + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FinInstnId": { + "Nm": { "allOf": [ { - "title": "FinancialInstitutionIdentification18", + "title": "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", - "description": "Information used to identify a financial institution.\n", + "description": "Information that locates and identifies a specific address, as defined by postal services.\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": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", "properties": { - "ClrSysId": { + "Cd": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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" - ] - } + "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" ], - "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 + "example": "ADDR" }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Code\nType of address expressed as a code.\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 + "Cd" + ] }, { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "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" - ], + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "example": "ADDR" + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } - ] + "description": "Issuer\nEntity that assigns the identification.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "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": [ - "Prtry" ] } + }, + "required": [ + "Id", + "Issr" ], "example": { - "Cd": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "Prtry" + ] } - ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 + ], + "example": { + "Cd": "ADDR" + } }, - "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" + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, - "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", - "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" - } - ] + "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 }, - "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" - } - ] + "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 }, - "Nm": { - "allOf": [ - { - "title": "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" - } - ] + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ + { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "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" - } - ] + "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", + "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 }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "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\nIdentification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "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" + } + ] }, - { - "description": "Issuer\nEntity that assigns the identification.\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" + } + ] } - ] - }, - "SchmeNm": { - "allOf": [ + }, + "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 + "properties": { + "Cd": {} + } }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "properties": { + "Prtry": {} + } } - ] + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } + ] }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "ADDR" + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } } }, - "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 + { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } - }, - "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" + ] } + }, + "required": [ + "OrgId" ] - } - }, - "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", - "UpdtdPtyAndAcctId" - ], - "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", - "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" - }, - { - "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", - "properties": { - "Assgnmt": { - "allOf": [ - { - "title": "IdentificationAssignment3", - "type": "object", - "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", - "format": "datetime", - "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", - "oneOf": [ - { - "properties": { - "Pty": { - "allOf": [ - { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - ] - }, + "PrvtId": { + "allOf": [ { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", "properties": { - "Prtry": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "GenericIdentification30", + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", "type": "object", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { + "BirthDt": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "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", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "format": "date", + "example": "2013-03-07" }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "BirthDate\nDate on which a person was born.\n" } ] }, - "Issr": { + "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", @@ -82285,11 +79377,11 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, - "SchmeNm": { + "CityOfBirth": { "allOf": [ { "title": "Max35Text", @@ -82300,258 +79392,78 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "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": [ - "Id", - "Issr" + "BirthDt", + "CityOfBirth", + "CtryOfBirth" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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" - } - ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericPersonIdentification2", + "type": "object", + "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 }, - "SchmeNm": { - "allOf": [ + { + "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", + "anyOf": [ { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", - "type": "object", "properties": { "Cd": { "allOf": [ { - "title": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification code.", + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, @@ -82561,7 +79473,14 @@ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { "Prtry": { "allOf": [ { @@ -82578,711 +79497,981 @@ ] } }, - "oneOf": [ - { - "properties": { - "Cd": {} - } - }, - { - "properties": { - "Prtry": {} - } - } - ], - "example": { - "Cd": "BIC" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "CCPT" + } }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] + { + "description": "SchemeName\nName of the identification scheme.\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" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] } - ] - } - }, - "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" }, - "Issr": "BIC" + "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" }, - { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] + } + }, + { + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } - }, - "required": [ - "OrgId" ] + } + }, + "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", + "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", "properties": { - "PrvtId": { + "ChanlTp": { "allOf": [ { - "title": "PersonIdentification13", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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 - } - } - } + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" + "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": [ - "PrvtId" - ] - } - ], - "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 } + }, + { + "description": "OtherContact\nContact details in another form.\n" } - } + ] }, - { - "description": "Identification\nUnique and unambiguous way to identify an organisation.\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" + } }, - "CtryOfRes": { + { + "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", + "anyOf": [ + { + "properties": { + "Cd": { "allOf": [ { - "title": "CountryCode", + "title": "ExternalStatusReason1Code", + "description": "Specifies the external status reason code.", "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "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" + "description": "Code\nReason for the status, as published in an external reason code list.\n" } ] - }, - "CtctDtls": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "Contact4", - "description": "Specifies the details of the contact person.\n", - "type": "object", - "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", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" + "description": "Proprietary\nReason for the status, in a proprietary form.\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" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "AGNT" + } + }, + { + "description": "Reason\nSpecifies the reason for the status report.\n" } - }, - "required": [ - "Pty" ] }, - { - "properties": { - "Agt": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification6", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification18", - "type": "object", - "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" - } - ] + "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", + "format": "datetime", + "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 with a length of 32 characters.\n", + "type": "string", + "example": "1234567890ABCDEF1234567890ABCDEF" + }, + { + "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", + "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" + }, + { + "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" + } + ] + } + }, + "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", + "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" + }, + { + "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", + "properties": { + "GrpHdr": { + "allOf": [ + { + "title": "GroupHeader120", + "description": "Set of characteristics shared by all individual transactions included in the message.\n", + "type": "object", + "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", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "CreationDateTime\nDate and time at which the message was created.\n" + } + ] + }, + "TxInfAndSts": { + "allOf": [ + { + "title": "PaymentTransaction163", + "description": "Provides further details on the original transactions, to which the status report message refers.\n", + "type": "object", + "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.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Specifies the status of the transaction.\n" + } + ] + }, + "StsRsnInf": { + "allOf": [ + { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Orgtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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 }, - "ClrSysMmbId": { - "allOf": [ - { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + { + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ + "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", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "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": 5, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nClearing system identification code, as published in an external list.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "SchmeNm": { "allOf": [ { "title": "Max35Text", @@ -83293,73 +80482,61 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Prtry" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - ], - "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": [ + "Prtry" ] } - }, - "required": [ - "MmbId" ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Cd": "ADDR" } }, - { - "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", + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 140, + "example": 12345 }, - { - "description": "LEI\nLegal entity identifier of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { + "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", @@ -83367,89 +80544,262 @@ "maxLength": 140, "example": 12345 }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + "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" + } }, - "PstlAdr": { - "allOf": [ + { + "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", + "anyOf": [ { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "OrgId": { + "allOf": [ { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", "properties": { - "Cd": { + "AnyBIC": { "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" - ], + "title": "AnyBICDec2014Identifier", "type": "string", - "example": "ADDR" + "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": "Code\nType of address expressed as a code.\n" + "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "LEI": { "allOf": [ { - "title": "GenericIdentification30", + "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", - "description": "Generic scheme identification for a party.\n", + "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "minLength": 1, + "maxLength": 256, + "example": 256 }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "Identification\nIdentification assigned by an institution.\n" } ] }, - "Issr": { + "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 + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "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": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "SchmeNm": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -83460,461 +80810,226 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Id", - "Issr" + "Id" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } - ] - } + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" }, - "required": [ - "Prtry" - ] + "Issr": "BIC" } - ], - "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" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\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", - "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 + "OrgId" + ] }, { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "PrvtId": { + "allOf": [ { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", "properties": { - "Cd": { + "DtAndPlcOfBirth": { "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" + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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" ], - "type": "string", - "example": "ADDR" + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Othr": { "allOf": [ { - "title": "GenericIdentification30", + "title": "GenericPersonIdentification2", "type": "object", - "description": "Generic scheme identification for a party.\n", + "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "minLength": 1, + "maxLength": 256, + "example": 256 }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Issr": { + "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 + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "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": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "SchmeNm": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -83925,117 +81040,197 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Id", - "Issr" + "Id" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Prtry" - ] + "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", + "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" ], - "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 + "example": "DOCT" }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + { + "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": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + { + "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", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", + { + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + } + ] + }, + "MobNb": { + "allOf": [ + { + "title": "PhoneNumber", "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + { + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + } + ] + }, + "FaxNb": { + "allOf": [ + { + "title": "PhoneNumber", "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", + { + "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": 16, - "example": 1234567890123456 + "maxLength": 2048, + "example": 2048 }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + { + "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": 35, - "example": 1.234567890123457e+34 + "maxLength": 256, + "example": 256 }, - "TwnLctnNm": { + { + "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", @@ -84043,7 +81238,14 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "DstrctNm": { + { + "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", @@ -84051,7 +81253,14 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "CtrySubDvsn": { + { + "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", @@ -84059,392 +81268,787 @@ "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": { + { + "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" } - }, - "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" + "Othr": { + "allOf": [ + { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "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": { - "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" + }, + "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" } - } - }, - { - "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" + }, + "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" + } + } }, - "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": "Originator\nParty that issues the status.\n" + } + ] + }, + "Rsn": { + "allOf": [ + { + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", + "type": "object", + "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" } }, - { - "description": "Agent\nIdentification of a financial institution.\n" + "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", + "format": "datetime", + "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 with a length of 32 characters.\n", + "type": "string", + "example": "1234567890ABCDEF1234567890ABCDEF" + }, + { + "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", + "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" + }, + { + "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": [ - "Agt" ] } - ], + }, "example": { - "Pty": { - "Nm": "Name", - "PstlAdr": { - "Ctry": "US", - "AdrLine": [ - "Line1", - "Line2" - ] - }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - } - } + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" }, - "Agt": { - "FinInstnId": { - "BICFI": "BUKBGB22" - }, - "BrnchId": { - "Id": 12345, - "Nm": "Oxford Street Branch", - "PstlAdr": { - "Ctry": "GB", - "AdrLine": [ - "1 Oxford Street", - "London", - "UK" - ] - } - } + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" } } }, { - "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n" + "description": "TransactionInformationAndStatus\nDefinition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).\nUsage: The instructing agent is the party sending the status message and not the party that sent the original instruction that is being reported on.\n" } ] - }, - "Assgne": { - "allOf": [ - { - "title": "Party40Choice", - "description": "Identification of a person, an organisation or a financial institution.\n", - "type": "object", - "oneOf": [ + } + }, + "required": [ + "MsgId", + "CreDtTm" + ], + "example": { + "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" + } + } + } + }, + { + "description": "Set of characteristics shared by all individual transactions included in the message.\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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ + { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "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", + "description": "Information that locates and identifies an organisation.\n", "properties": { - "Pty": { + "Id": { "allOf": [ { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "Max35Text", + "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", "properties": { - "Nm": { + "Cd": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 4, + "example": 1234 }, { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, - "PstlAdr": { + "Prtry": { "allOf": [ { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", + "title": "Max35Text", + "description": "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", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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", + "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 4, + "example": 1234 }, - "CtrySubDvsn": { + { + "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", @@ -84452,601 +82056,188 @@ "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 + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } - }, - "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" + ] } + }, + "required": [ + "Prtry" ] - }, - "Id": { - "allOf": [ - { - "title": "Party38Choice", - "description": "Nature or use of the account.\n", - "type": "object", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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": { + } + ], + "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", + "anyOf": [ + { + "properties": { + "Pty": { + "allOf": [ + { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { "allOf": [ { - "title": "CountryCode", + "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", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + "example": "ADDR" }, { - "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" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "CtctDtls": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "Contact4", - "description": "Specifies the details of the contact person.\n", + "title": "GenericIdentification30", "type": "object", + "description": "Generic scheme identification for a party.\n", "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": { + "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "JobTitl": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -85057,11 +82248,11 @@ "example": 1.234567890123457e+34 }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "Rspnsblty": { + "SchmeNm": { "allOf": [ { "title": "Max35Text", @@ -85072,515 +82263,308 @@ "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", - "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" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, + "required": [ + "Id", + "Issr" + ], "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "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 } }, - "required": [ - "Pty" - ] + "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" + } }, { - "properties": { - "Agt": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification6", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification18", - "type": "object", - "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" - } - ] + "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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ + { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "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" }, - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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" - } - ] + { + "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", + "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 }, - "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" - } - ] + { + "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "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" - } - ] + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } + }, + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } ], "example": { - "Cd": "ADDR" + "Cd": "BIC" } }, - "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": { + { + "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", @@ -85588,15 +82572,84 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + { + "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", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "format": "date", + "example": "2013-03-07" }, - "DstrctNm": { + { + "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", @@ -85604,7 +82657,14 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "CtrySubDvsn": { + { + "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", @@ -85612,280 +82672,86 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { + { + "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" }, - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } - ] + { + "description": "CountryOfBirth\nCountry where a person was born.\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 + "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" } - } + ] }, - { - "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", - "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 + "Othr": { + "allOf": [ + { + "title": "GenericPersonIdentification1", + "type": "object", + "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" + } + ] }, - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "SchmeNm": { + "allOf": [ + { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "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" - ], + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", "type": "string", - "example": "ADDR" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } @@ -85899,67 +82765,15 @@ "Prtry": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -85970,106 +82784,17 @@ } ], "example": { - "Cd": "ADDR" + "Cd": "CCPT" } }, - "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": { + { + "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", @@ -86077,252 +82802,181 @@ "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 + { + "description": "Issuer\nEntity that assigns the identification.\n" } - }, - "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" + }, + "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" }, - { - "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" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] - } - }, - "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": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } - } - }, - { - "description": "Agent\nIdentification of a financial institution.\n" + ] } + }, + "required": [ + "PrvtId" ] } - }, - "required": [ - "Agt" - ] - } - ], - "example": { - "Pty": { - "Nm": "Name", - "PstlAdr": { - "Ctry": "US", - "AdrLine": [ - "Line1", - "Line2" - ] - }, - "Id": { + ], + "example": { "OrgId": { "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } } }, - "Agt": { - "FinInstnId": { - "BICFI": "BUKBGB22" - }, - "BrnchId": { - "Id": 12345, - "Nm": "Oxford Street Branch", - "PstlAdr": { - "Ctry": "GB", - "AdrLine": [ - "1 Oxford Street", - "London", - "UK" - ] - } - } + { + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } - } - }, - { - "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", - "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" + "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" + } + ] }, - { - "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n" - } - ] - }, - "Rsn": { - "allOf": [ - { - "title": "VerificationReason1Choice", - "type": "object", - "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", - "oneOf": [ + "CtctDtls": { + "allOf": [ { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", "properties": { - "Cd": { + "NmPrfx": { "allOf": [ { - "title": "ExternalVerificationReason1Code", - "description": "Specifies the external verification reason code.", + "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": 4, - "example": 1234 + "maxLength": 140, + "example": 12345 }, { - "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "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", @@ -86333,85 +82987,254 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n" + "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", + "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" } ] } }, - "required": [ - "Prtry" - ] + "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" + } } - ], - "example": { - "Cd": "AGNT" } }, - { - "description": "Reason\nSpecifies the reason why the verified identification information is incorrect.\n" + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" } - ] + } }, - "OrgnlPtyAndAcctId": { - "allOf": [ - { - "title": "IdentificationInformation4", - "type": "object", - "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", - "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" - } - ] + { + "description": "Party\nIdentification of a person or an organisation.\n" + } + ] + } + }, + "required": [ + "Pty" + ] + }, + { + "properties": { + "Agt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "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" }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + { + "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", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "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" - ], + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", "type": "string", - "example": "ADDR" + "minLength": 1, + "maxLength": 5, + "example": 12345 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } @@ -86425,67 +83248,15 @@ "Prtry": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } @@ -86496,106 +83267,17 @@ } ], "example": { - "Cd": "ADDR" + "Cd": "CHIPS" } }, - "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": { + { + "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", @@ -86603,902 +83285,599 @@ "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 + { + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } - }, - "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" + ] } - ] + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } }, - "Id": { - "allOf": [ - { - "title": "Party38Choice", - "description": "Nature or use of the account.\n", + { + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "oneOf": [ + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { "properties": { - "OrgId": { + "Cd": { "allOf": [ { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", + "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", + "description": "Generic scheme identification for a party.\n", "properties": { - "AnyBIC": { + "Id": { "allOf": [ { - "title": "AnyBICDec2014Identifier", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "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" + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "AnyBIC\nBusiness identification code of the organisation.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "LEI": { + "Issr": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "Othr": { + "SchmeNm": { "allOf": [ { - "title": "GenericOrganisationIdentification1", - "type": "object", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, + "required": [ + "Id", + "Issr" + ], "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ - "OrgId" - ] - }, - { - "properties": { - "PrvtId": { - "allOf": [ - { - "title": "PersonIdentification13", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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" + "Prtry" ] } ], "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } + "Cd": "ADDR" } }, - { - "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" - } - ] - }, - "CtryOfRes": { - "allOf": [ - { + "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" }, - { - "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" + "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" + } }, - "CtctDtls": { - "allOf": [ - { - "title": "Contact4", - "description": "Specifies the details of the contact person.\n", - "type": "object", - "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" - } - ] + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericFinancialIdentification1", + "type": "object", + "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 }, - "Othr": { - "allOf": [ + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", - "type": "object", "properties": { - "ChanlTp": { + "Cd": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", "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" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, - "Id": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 128, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ - "ChanlTp" - ], - "example": { - "ChanlTp": "PHON", - "Id": 1234567890 - } - }, - { - "description": "Other\nContact details in another form.\n" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "BIC" + } }, - "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" - } - ] + { + "description": "SchemeName\nName of the identification scheme.\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" - } + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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" } }, - "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": "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 }, - { - "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" + "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 } - ] + } }, - "Acct": { - "allOf": [ - { - "title": "CashAccount40", - "type": "object", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", + { + "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", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { "properties": { - "IBAN": { + "Cd": { "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", + "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "example": "ADDR" }, { - "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" + "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ - "IBAN" + "Cd" ] }, { "properties": { - "Othr": { + "Prtry": { "allOf": [ { - "title": "GenericAccountIdentification1", + "title": "GenericIdentification30", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "SchmeNm": { + "Issr": { "allOf": [ { - "title": "AccountSchemeName1Choice", - "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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 - } + "title": "Max35Text", + "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\nName of the identification scheme.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "Issr": { + "SchmeNm": { "allOf": [ { "title": "Max35Text", @@ -87509,85 +83888,23 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Id" + "Id", + "Issr" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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", - "oneOf": [ - { - "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" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } @@ -87598,31 +83915,18 @@ } ], "example": { - "Cd": "CACC" + "Cd": "ADDR" } }, - { - "description": "Type\nSpecifies the nature, or use of the account.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "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": [ - { + "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", @@ -87630,501 +83934,1025 @@ "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" - } - ] + "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" + } }, - "Prxy": { - "allOf": [ + { + "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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ + { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "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", + "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", + "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": [ { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", - "type": "object", "properties": { - "Tp": { + "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", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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", + "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", + "anyOf": [ + { + "properties": { + "Cd": { "allOf": [ { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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" - } + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "Type\nType of the proxy identification.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, - "Id": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 2048, - "example": 2048 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ - "Id" - ], - "example": { - "Tp": { - "Cd": "IBAN" - }, - "Id": 123 - } - }, - { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "Prtry" + ] } - ] - } - }, - "example": { - "Id": { - "IBAN": "BE71096123456769" + ], + "example": { + "Cd": "CCPT" + } }, - "Tp": { - "Cd": "CACC" + { + "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 }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 + { + "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", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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": "Account\nUnambiguous identification of the account of a party.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "Agt": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification6", + "title": "GenericIdentification30", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "description": "Generic scheme identification for a party.\n", "properties": { - "FinInstnId": { + "Id": { "allOf": [ { - "title": "FinancialInstitutionIdentification18", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", + "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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ + { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "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", + "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", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 4, + "example": 1234 }, - "CtrySubDvsn": { + { + "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", @@ -88132,130 +84960,234 @@ "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 + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } - }, - "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" + ] + } + }, + "anyOf": [ + { + "properties": { + "Cd": {} } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "properties": { + "Prtry": {} + } } - ] + ], + "example": { + "Cd": "BIC" + } }, - "Othr": { - "allOf": [ + { + "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", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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", + "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", + "anyOf": [ { - "title": "GenericFinancialIdentification1", - "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { - "Id": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } + "maxLength": 4, + "example": 1234 }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, - "Issr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -88266,699 +85198,913 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\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" + "Prtry" + ] } - ] - } - }, - "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" + ], + "example": { + "Cd": "CCPT" + } }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + { + "description": "SchemeName\nName of the identification scheme.\n" } - } + ] }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary 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" + } }, - "BrnchId": { - "allOf": [ - { - "title": "BranchData3", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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": "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", + "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", + "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": "Agent\nFinancial institution servicing an account for a party.\n" + "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": [ - "Pty" + "ChanlTp" ], "example": { - "Pty": { - "Id": { - "OrgId": { - "AnyBIC": { - "BICFI": "BICFI" - } - } - }, - "CtryOfRes": "FI" - }, - "Acct": { - "Id": { - "IBAN": "FI2112345600000785" - } - }, - "Agt": { - "FinInstnId": { - "BICFI": "BICFI" - } - } + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n" + "description": "Other\nContact details in another form.\n" } ] }, - "UpdtdPtyAndAcctId": { + "PrefrdMtd": { "allOf": [ { - "title": "IdentificationInformation4", - "type": "object", - "description": "Information that locates and identifies a specific party or account.\n", + "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", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { "properties": { - "Pty": { + "Cd": { "allOf": [ { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", + "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", + "description": "Generic scheme identification for a party.\n", "properties": { - "Nm": { + "Id": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "PstlAdr": { + "SchmeNm": { "allOf": [ { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "title": "Max35Text", + "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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ + { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "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", + "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", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "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" - } - ] + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } + }, + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } ], "example": { - "Cd": "ADDR" + "Cd": "BIC" } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + { + "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": 70, - "example": 1.2345678901234567e+99 + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "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", + { + "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", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "format": "date", + "example": "2013-03-07" }, - "DstrctNm": { + { + "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", @@ -88966,7 +86112,14 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "CtrySubDvsn": { + { + "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", @@ -88974,834 +86127,1063 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { + { + "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" }, - "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 + { + "description": "CountryOfBirth\nCountry where a person was born.\n" } - }, - "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" + ] } - ] + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } }, - "Id": { - "allOf": [ - { - "title": "Party38Choice", - "description": "Nature or use of the account.\n", - "type": "object", - "oneOf": [ + { + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericPersonIdentification2", + "type": "object", + "description": "Identification of a person.", + "properties": { + "Id": { + "allOf": [ { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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" - ] + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 }, { - "properties": { - "PrvtId": { - "allOf": [ - { - "title": "PersonIdentification13", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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 identification of a person.\n" } - } - }, - { - "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", - "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": [ + "SchmeNm": { + "allOf": [ + { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "anyOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", - "type": "object", "properties": { - "ChanlTp": { + "Cd": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", "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" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, - "Id": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 128, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ - "ChanlTp" - ], - "example": { - "ChanlTp": "PHON", - "Id": 1234567890 - } - }, - { - "description": "Other\nContact details in another form.\n" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "CCPT" + } }, - "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" - } - ] + { + "description": "SchemeName\nName of the identification scheme.\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" - } + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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" } }, - "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": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } - } + ] + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] + } }, - "Acct": { - "allOf": [ - { - "title": "CashAccount40", - "type": "object", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + { + "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", + "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", + "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", + "properties": { + "InstrId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "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" + } + ] + }, + "EndToEndId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "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" + } + ] + }, + "TxId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" + } + ] + }, + "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", + "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.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Specifies the status of the transaction.\n" + } + ] + }, + "StsRsnInf": { + "allOf": [ + { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Orgtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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" + } + ] }, - { - "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" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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": [ - "IBAN" ] - }, + } + }, + "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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", "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": "GenericAccountIdentification1", + "title": "GenericOrganisationIdentification3", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 + "maxLength": 256, + "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" @@ -89811,57 +87193,55 @@ "SchmeNm": { "allOf": [ { - "title": "AccountSchemeName1Choice", + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } + }, + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } ], "example": { - "Cd": 1111 + "Cd": "BIC" } }, { @@ -89891,160 +87271,70 @@ "example": { "Id": 123, "SchmeNm": { - "Cd": "IBAN" + "Cd": "BIC" }, "Issr": "BIC" } }, { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Othr" - ] + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } - ], - "example": { - "IBAN": "BE71096123456769" - } - }, - { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" + ] } + }, + "required": [ + "OrgId" ] }, - "Tp": { - "allOf": [ - { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", - "type": "object", - "oneOf": [ + { + "properties": { + "PrvtId": { + "allOf": [ { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", "properties": { - "Cd": { + "DtAndPlcOfBirth": { "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", "properties": { - "Cd": { + "BirthDt": { "allOf": [ { - "title": "ExternalProxyAccountType1Code", - "description": "Specifies the external proxy account type code.", + "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", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "format": "date", + "example": "2013-03-07" }, { - "description": "Code\nProxy account type, in a coded form as published in an external list.\n" + "description": "BirthDate\nDate on which a person was born.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", @@ -90055,310 +87345,111 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProxy account type, in a proprietary form.\n" + "description": "ProvinceOfBirth\nProvince where a person was born.\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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification18", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ + }, + "CityOfBirth": { + "allOf": [ { - "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" - ] + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "description": "CityOfBirth\nCity where a person was born.\n" } - ], - "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" + "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" + } }, - "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" - } - ] + { + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "Othr": { + "allOf": [ + { + "title": "GenericPersonIdentification2", "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "SchmeNm": { + "allOf": [ + { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "anyOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 4, + "example": 1234 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, - "SchmeNm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -90369,790 +87460,572 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "CCPT" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "Issr": { + "allOf": [ { - "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" - ] + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "description": "Issuer\nEntity that assigns the identification.\n" } - ], - "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 + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + "Issr": "BIC" + } }, - "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" }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] - } - }, - "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": "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", + "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, - "BrnchId": { + "Nm": { "allOf": [ { - "title": "BranchData3", + "title": "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", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { - "Id": { + "ChanlTp": { "allOf": [ { - "title": "Max35Text", - "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", + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "Nm": { + "Id": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, + "maxLength": 128, "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, + "required": [ + "ChanlTp" + ], "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" - } + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "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" + "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" } ] } }, - "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" - } - } + "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": "Agent\nFinancial institution servicing an account for a party.\n" + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ - "Pty" + "Id" ], "example": { - "Pty": { - "Id": { - "OrgId": { - "AnyBIC": { - "BICFI": "BICFI" - } - } - }, - "CtryOfRes": "FI" + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" }, - "Acct": { - "Id": { - "IBAN": "FI2112345600000785" + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } }, - "Agt": { - "FinInstnId": { - "BICFI": "BICFI" - } + "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": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n" + "description": "Originator\nParty that issues the status.\n" + } + ] + }, + "Rsn": { + "allOf": [ + { + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", + "type": "object", + "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" } ] } }, - "required": [ - "OrgnlId", - "Vrfctn", - "UpdtdPtyAndAcctId" - ], "example": { - "OrgnlId": 1.2345678901234568e+33, - "Vrfctn": true, - "OrgnlPtyAndAcctId": { - "Nm": "John Doe", + "Orgtr": { + "Nm": "Name", "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" - } - } + "Dept": "Department", + "SubDept": "SubDepartment", + "StrtNm": "StreetName", + "BldgNb": "BuildingNumber", + "PstCd": "PostCode", + "TwnNm": "TownName", + "CtrySubDvsn": "CountrySubDivision", + "Ctry": "Country" } }, - "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" - } - } - } - } + "Rsn": { + "Cd": "AGNT" + }, + "AddtlInf": "AdditionalInformation" } }, { - "description": "Report\nInformation concerning the verification of the identification data for which verification was requested.\n" + "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", + "format": "datetime", + "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 with a length of 32 characters.\n", + "type": "string", + "example": "1234567890ABCDEF1234567890ABCDEF" + }, + { + "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n" } ] }, @@ -91203,525 +88076,393 @@ } }, { - "description": "SupplementaryData\nAdditional information that cannot be captured in the structured elements and/or any other specific block.\n" + "description": "Additional 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" - } - } - } + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" }, - "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" - } - } - } + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" } } }, - "GroupHeader113": { - "title": "GroupHeader113", - "description": "Set of characteristics shared by all individual transactions included in the message.\n", + "PaymentTypeInformation28": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", "type": "object", "properties": { - "MsgId": { + "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": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "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": "Message Identification\n" + "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, - "CreDtTm": { + "LclInstrm": { "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", - "format": "datetime", - "example": "2013-03-07T14:44:30.000Z" + "title": "LocalInstrument2Choice", + "type": "object", + "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": "Creation Date and Time\n" + "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" } ] }, - "NbOfTxs": { + "CtgyPurp": { "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 + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "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": "Number of Transactions\n" + "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" }, - "TtlIntrBkSttlmAmt": { + "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", + "properties": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "ActiveCurrencyAndAmount", + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", "type": "object", - "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": { + "BirthDt": { "allOf": [ { - "title": "ActiveCurrencyAndAmount_SimpleType", + "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", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "format": "date", + "example": "2013-03-07" + }, + { + "description": "BirthDate\nDate on which a person was born.\n" } ] }, - "Ccy": { + "PrvcOfBirth": { "allOf": [ { - "title": "ActiveCurrencyCode", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[A-Z]{3,3}$", - "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\".", - "example": "USD" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "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": [ - "ActiveCurrencyAndAmount", - "Ccy" + "BirthDt", + "CityOfBirth", + "CtryOfBirth" ], "example": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" } }, { - "description": "Total Interbank Settlement Amount\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, - "SttlmInf": { + "Othr": { "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", + "title": "GenericPersonIdentification1", "type": "object", + "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "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", - "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", + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "enum": [ - "RTGS", - "RTNS", - "MPNS", - "BOOK" - ], - "example": "RTGS" - }, - "SvcLvl": { - "allOf": [ - { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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" - } - } - } + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "CtryOfRes": "CH", - "CtctDtls": { - "Nm": "Name", - "PhneNb": 123, - "EmailAdr": null + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" } - } - } - } - }, - { - "description": "Settlement Information\n" - } - ] - }, - "PmtTpInf": { - "allOf": [ - { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", - "type": "object", - "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": { + "SchmeNm": { "allOf": [ { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification 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" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } @@ -91743,7 +88484,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -91754,95 +88495,192 @@ } ], "example": { - "Cd": "SEPA" + "Cd": "CCPT" } }, { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "LclInstrm": { + "Issr": { "allOf": [ { - "title": "LocalInstrument2Choice", - "type": "object", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "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" + "description": "Issuer\nEntity that assigns the identification.\n" } ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" }, - "CtgyPurp": { + "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", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { "allOf": [ { - "title": "CategoryPurpose1Choice", - "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "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", + "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", - "oneOf": [ + "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, + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", "type": "string", + "minLength": 1, + "maxLength": 4, "example": 1234 }, { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } @@ -91864,7 +88702,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nCategory purpose, in a proprietary form.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -91875,64 +88713,182 @@ } ], "example": { - "Cd": "CASH" + "Cd": "CCPT" } }, { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "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": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" }, - "CtgyPurp": { - "Cd": "CASH" - } + "Issr": "BIC" } }, { - "description": "Payment Type Information\n" + "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" }, - "CdtTrfTxInf": { - "allOf": [ + "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", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "CreditTransferTransaction68", - "description": "Provides further details specific to the individual transaction(s) included in the message.\n", - "type": "object", "properties": { - "PmtId": { + "Cd": { "allOf": [ { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", + "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", + "description": "Generic scheme identification for a party.\n", "properties": { - "InstrId": { + "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "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" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "EndToEndId": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -91943,11 +88899,11 @@ "example": 1.234567890123457e+34 }, { - "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" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "TxId": { + "SchmeNm": { "allOf": [ { "title": "Max35Text", @@ -91958,24 +88914,251 @@ "example": 1.234567890123457e+34 }, { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "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", + "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" } ] }, - "UETR": { + "Issr": { "allOf": [ { - "title": "UUIDv4Identifier", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "ClrSysRef": { + "SchmeNm": { "allOf": [ { "title": "Max35Text", @@ -91986,44712 +89169,1366 @@ "example": 1.234567890123457e+34 }, { - "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "TxId" + "Id", + "Issr" ], "example": { - "InstrId": "INSTRUCTIONID", - "EndToEndId": "ENDTOENDID", - "TxId": "TRANSACTIONID", - "UETR": "123e4567-e89b-12d3-a456-426614174000", - "ClrSysRef": "CLRSYSREF" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] - }, - "PmtTpInf": { - "allOf": [ - { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", - "type": "object", - "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", - "oneOf": [ - { - "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", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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" + } + }, + "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", + "properties": { + "Tp": { + "allOf": [ + { + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, - "CtgyPurp": { - "Cd": "CASH" + { + "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } - } - }, - { - "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" + ] } + }, + "required": [ + "Cd" ] }, - "IntrBkSttlmAmt": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "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", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - } - ] + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "pattern": "^[A-Z]{3,3}$", - "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\".", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] + { + "description": "Proprietary\nProxy account type, in a proprietary form.\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" + ] } + }, + "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, - "Dbtr": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" - } - ] + { + "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 }, - "DbtrAcct": { - "allOf": [ - { - "title": "CashAccount40", - "type": "object", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" - }, - { - "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", - "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", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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" - } - ] + { + "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPurpose1Code", + "description": "Specifies the external purpose code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, - "DbtrAgt": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" - } - ] + { + "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 }, - "CdtrAgt": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" - }, - { - "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", - "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", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "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", - "oneOf": [ - { - "properties": { - "IlpV4PrepPacket": { - "allOf": [ - { - "title": "hexBinary", - "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 - }, - { - "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" - } - ] - } - }, - "required": [ - "IlpV4PrepPacket" - ] - }, - { - "properties": { - "Sh256Sgntr": { - "allOf": [ - { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", - "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" - }, - { - "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": [ - "MsgId", - "CreDtTm", - "NbOfTxs", - "SttlmInf", - "CdtTrfTxInf" - ], - "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" - }, - "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" - } - }, - "CdtrAgtAcct": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Ccy": "EUR" - }, - "RmtInf": { - "Ustrd": "Test" - } - } - } - }, - "GroupHeader120": { - "title": "GroupHeader120", - "description": "Set of characteristics shared by all individual transactions included in the message.\n", - "type": "object", - "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", - "format": "datetime", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "CreationDateTime\nDate and time at which the message was created.\n" - } - ] - }, - "TxInfAndSts": { - "allOf": [ - { - "title": "PaymentTransaction163", - "description": "Provides further details on the original transactions, to which the status report message refers.\n", - "type": "object", - "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", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "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.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Specifies the status of the transaction.\n" - } - ] - }, - "StsRsnInf": { - "allOf": [ - { - "title": "StatusReasonInformation14", - "description": "Unsure on description.\n", - "type": "object", - "properties": { - "Orgtr": { - "allOf": [ - { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "oneOf": [ - { - "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", - "format": "datetime", - "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 with a length of 32 characters.\n", - "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" - }, - { - "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", - "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" - }, - { - "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" - } - ] - } - }, - "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": "TransactionInformationAndStatus\nDefinition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).\nUsage: The instructing agent is the party sending the status message and not the party that sent the original instruction that is being reported on.\n" - } - ] - } - }, - "required": [ - "MsgId", - "CreDtTm" - ], - "example": { - "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" - } - } - } - }, - "GroupHeader129": { - "title": "GroupHeader129", - "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n", - "type": "object", - "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", - "format": "datetime", - "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", - "format": "datetime", - "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", - "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", - "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", - "oneOf": [ - { - "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", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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" - } - ] - }, - "CdtTrfTxInf": { - "allOf": [ - { - "title": "CreditTransferTransaction67", - "description": "Provides further details specific to the individual transaction(s) included in the message.\n", - "type": "object", - "properties": { - "PmtId": { - "allOf": [ - { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", - "type": "object", - "properties": { - "InstrId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "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", - "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", - "oneOf": [ - { - "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", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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" - } - ] - }, - "IntrBkSttlmAmt": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "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", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "pattern": "^[A-Z]{3,3}$", - "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\".", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 0.7 - }, - { - "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\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n", - "type": "string", - "enum": [ - "DEBT", - "CRED", - "SHAR", - "SLEV" - ], - "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", - "properties": { - "Amt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" - }, - { - "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", - "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", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" - }, - { - "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", - "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", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Cdtr": { - "allOf": [ - { - "title": "TaxParty1", - "description": "Details about the entity involved in the tax paid or to be paid.\n", - "type": "object", - "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", - "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", - "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", - "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", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "pattern": "^[\\d\\-\\.\\,]{1,18}$", - "example": 256 - }, - { - "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", - "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", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "properties": { - "Rate": { - "allOf": [ - { - "title": "PercentageRate", - "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 - }, - { - "description": "Rate\n\nRate used to calculate the tax.\n" - } - ] - }, - "TaxblBaseAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "properties": { - "Rate": { - "allOf": [ - { - "title": "PercentageRate", - "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 - }, - { - "description": "Rate\n\nRate used to calculate the tax.\n" - } - ] - }, - "TaxblBaseAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "oneOf": [ - { - "properties": { - "IlpV4PrepPacket": { - "allOf": [ - { - "title": "hexBinary", - "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 - }, - { - "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" - } - ] - } - }, - "required": [ - "IlpV4PrepPacket" - ] - }, - { - "properties": { - "Sh256Sgntr": { - "allOf": [ - { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", - "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" - }, - { - "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": [ - "MsgId", - "CreDtTm", - "NbOfTxs", - "SttlmInf", - "CdtTrfTxInf" - ], - "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 - } - }, - "CdtTrfTxInf": { - "PmtId": { - "InstrId": 123, - "EndToEndId": 123 - }, - "PmtTpInf": { - "InstrPrty": "NORM" - }, - "InstdAmt": { - "Amt": 123, - "Ccy": "EUR" - }, - "ChrgBr": "SLEV", - "CdtrAgt": { - "FinInstnId": { - "BICFI": 123 - } - }, - "Cdtr": { - "Nm": "John Doe" - }, - "CdtrAcct": { - "Id": { - "IBAN": 123 - } - }, - "RmtInf": { - "Ustrd": "Test" - } - } - } - }, - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" - }, - "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", - "format": "datetime", - "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", - "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", - "format": "datetime", - "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", - "oneOf": [ - { - "properties": { - "Pty": { - "allOf": [ - { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification18", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "Pty": { - "allOf": [ - { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification18", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" - }, - { - "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", - "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", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification18", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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." - } - }, - "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", - "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", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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", - "pattern": "^[\\d\\-\\.\\,]{1,18}$", - "example": 256 - }, - "OrganisationIdentification29": { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "properties": { - "Cd": {} - } - }, - { - "properties": { - "Prtry": {} - } - } - ], - "example": { - "Cd": "BIC" - } - }, - "OtherContact1": { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", - "type": "object", - "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", - "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", - "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", - "format": "datetime", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "CreationDateTime\nDate and time at which the message was created.\n" - } - ] - }, - "TxInfAndSts": { - "allOf": [ - { - "title": "PaymentTransaction163", - "description": "Provides further details on the original transactions, to which the status report message refers.\n", - "type": "object", - "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", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "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.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Specifies the status of the transaction.\n" - } - ] - }, - "StsRsnInf": { - "allOf": [ - { - "title": "StatusReasonInformation14", - "description": "Unsure on description.\n", - "type": "object", - "properties": { - "Orgtr": { - "allOf": [ - { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "oneOf": [ - { - "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", - "format": "datetime", - "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 with a length of 32 characters.\n", - "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" - }, - { - "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", - "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" - }, - { - "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" - } - ] - } - }, - "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": "TransactionInformationAndStatus\nDefinition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).\nUsage: The instructing agent is the party sending the status message and not the party that sent the original instruction that is being reported on.\n" - } - ] - } - }, - "required": [ - "MsgId", - "CreDtTm" - ], - "example": { - "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" - } - } - } - }, - { - "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", - "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", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "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.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Specifies the status of the transaction.\n" - } - ] - }, - "StsRsnInf": { - "allOf": [ - { - "title": "StatusReasonInformation14", - "description": "Unsure on description.\n", - "type": "object", - "properties": { - "Orgtr": { - "allOf": [ - { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "oneOf": [ - { - "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", - "format": "datetime", - "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 with a length of 32 characters.\n", - "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" - }, - { - "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", - "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" - }, - { - "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" - } - ] - } - }, - "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", - "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" - }, - { - "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", - "properties": { - "GrpHdr": { - "allOf": [ - { - "title": "GroupHeader120", - "description": "Set of characteristics shared by all individual transactions included in the message.\n", - "type": "object", - "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", - "format": "datetime", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "CreationDateTime\nDate and time at which the message was created.\n" - } - ] - }, - "TxInfAndSts": { - "allOf": [ - { - "title": "PaymentTransaction163", - "description": "Provides further details on the original transactions, to which the status report message refers.\n", - "type": "object", - "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", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "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.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Specifies the status of the transaction.\n" - } - ] - }, - "StsRsnInf": { - "allOf": [ - { - "title": "StatusReasonInformation14", - "description": "Unsure on description.\n", - "type": "object", - "properties": { - "Orgtr": { - "allOf": [ - { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "oneOf": [ - { - "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", - "format": "datetime", - "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 with a length of 32 characters.\n", - "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" - }, - { - "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", - "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" - }, - { - "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" - } - ] - } - }, - "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": "TransactionInformationAndStatus\nDefinition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).\nUsage: The instructing agent is the party sending the status message and not the party that sent the original instruction that is being reported on.\n" - } - ] - } - }, - "required": [ - "MsgId", - "CreDtTm" - ], - "example": { - "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" - } - } - } - }, - { - "description": "Set of characteristics shared by all individual transactions included in the message.\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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "oneOf": [ - { - "properties": { - "Pty": { - "allOf": [ - { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification18", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "properties": { - "InstrId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "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", - "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", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "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.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Specifies the status of the transaction.\n" - } - ] - }, - "StsRsnInf": { - "allOf": [ - { - "title": "StatusReasonInformation14", - "description": "Unsure on description.\n", - "type": "object", - "properties": { - "Orgtr": { - "allOf": [ - { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "oneOf": [ - { - "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", - "format": "datetime", - "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 with a length of 32 characters.\n", - "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" - }, - { - "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", - "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" - }, - { - "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" - } - ] - } - }, - "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", - "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", - "oneOf": [ - { - "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", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 - }, - "PersonIdentification13": { - "title": "PersonIdentification13", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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", - "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", - "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", - "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", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "oneOf": [ - { - "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", - "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", - "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", - "oneOf": [ - { - "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", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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", - "properties": { - "Orgtr": { - "allOf": [ - { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "oneOf": [ - { - "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", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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" - }, - { - "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" - }, - "TaxAmount3": { - "title": "TaxAmount3", - "description": "Information on the amount of the tax record.\n", - "type": "object", - "properties": { - "Rate": { - "allOf": [ - { - "title": "PercentageRate", - "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 - }, - { - "description": "Rate\n\nRate used to calculate the tax.\n" - } - ] - }, - "TaxblBaseAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "properties": { - "Cdtr": { - "allOf": [ - { - "title": "TaxParty1", - "description": "Details about the entity involved in the tax paid or to be paid.\n", - "type": "object", - "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", - "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", - "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", - "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", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "pattern": "^[\\d\\-\\.\\,]{1,18}$", - "example": 256 - }, - { - "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", - "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", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "properties": { - "Rate": { - "allOf": [ - { - "title": "PercentageRate", - "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 - }, - { - "description": "Rate\n\nRate used to calculate the tax.\n" - } - ] - }, - "TaxblBaseAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "properties": { - "Rate": { - "allOf": [ - { - "title": "PercentageRate", - "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 - }, - { - "description": "Rate\n\nRate used to calculate the tax.\n" - } - ] - }, - "TaxblBaseAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "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", - "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", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "properties": { - "Rate": { - "allOf": [ - { - "title": "PercentageRate", - "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 - }, - { - "description": "Rate\n\nRate used to calculate the tax.\n" - } - ] - }, - "TaxblBaseAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "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", - "format": "datetime", - "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", - "format": "datetime", - "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", - "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", - "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", - "oneOf": [ - { - "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", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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" - } - ] - }, - "CdtTrfTxInf": { - "allOf": [ - { - "title": "CreditTransferTransaction67", - "description": "Provides further details specific to the individual transaction(s) included in the message.\n", - "type": "object", - "properties": { - "PmtId": { - "allOf": [ - { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", - "type": "object", - "properties": { - "InstrId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "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", - "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", - "oneOf": [ - { - "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", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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" - } - ] - }, - "IntrBkSttlmAmt": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "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", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "pattern": "^[A-Z]{3,3}$", - "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\".", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 0.7 - }, - { - "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\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n", - "type": "string", - "enum": [ - "DEBT", - "CRED", - "SHAR", - "SLEV" - ], - "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", - "properties": { - "Amt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "oneOf": [ - { - "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", - "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" - } - ] - } + { + "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", + "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", + "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", + "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", + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "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", + "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})$" }, - "required": [ - "Amt", - "Agt" - ], - "example": { - "Amt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - }, - "Agt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "Tp": { - "Cd": "SHAR" - } + { + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "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", + "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", + "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalServiceLevel1Code", + "description": "Specifies the external service level code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n" + "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] - }, - "Dbtr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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": { + "title": "Max35Text", + "description": "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", + "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", + "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", + "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", + "properties": { + "Orgtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { "allOf": [ { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", - "type": "object", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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" - ] - } + "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" ], - "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" + "example": "ADDR" }, { - "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" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "CtctDtls": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "Contact13", - "description": "Specifies the details of the contact person.\n", + "title": "GenericIdentification30", "type": "object", + "description": "Generic scheme identification for a party.\n", "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": { + "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "JobTitl": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -136702,11 +90539,11 @@ "example": 1.234567890123457e+34 }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "Rspnsblty": { + "SchmeNm": { "allOf": [ { "title": "Max35Text", @@ -136717,277 +90554,287 @@ "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", - "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" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, + "required": [ + "Id", + "Issr" + ], "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" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "DbtrAcct": { - "allOf": [ - { - "title": "CashAccount40", - "type": "object", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ + { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "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", + "description": "Information related to an identification of an organisation.\n", "properties": { - "IBAN": { + "Id": { "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", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "minLength": 1, + "maxLength": 256, + "example": 256 }, { - "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" + "description": "Identification\nIdentification assigned by an institution.\n" } ] - } - }, - "required": [ - "IBAN" - ] - }, - { - "properties": { - "Othr": { + }, + "SchmeNm": { "allOf": [ { - "title": "GenericAccountIdentification1", + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { - "Id": { + "Cd": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 - }, - { - "description": "Identification\nIdentification assigned by an institution.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "AccountSchemeName1Choice", - "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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 - } + "maxLength": 4, + "example": 1234 }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, - "Issr": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -136998,74 +90845,33 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, - "required": [ - "Id" + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "Cd": "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", - "oneOf": [ - { - "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" + "description": "SchemeName\nName of the identification scheme.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -137076,536 +90882,83 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + "description": "Issuer\nEntity that assigns the identification.\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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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" - } + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" }, - { - "description": "Type\nType of the proxy identification.\n" - } - ] + "Issr": "BIC" + } }, - "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" - } - ] + { + "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" }, - "required": [ - "Id" - ], - "example": { - "Tp": { - "Cd": "IBAN" - }, - "Id": 123 - } - }, - { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "Issr": "BIC" } - ] - } - }, - "example": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" + } }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 + { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } - } - }, - { - "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" + ] } + }, + "required": [ + "OrgId" ] }, - "DbtrAgt": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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" - } - ] + { + "properties": { + "PrvtId": { + "allOf": [ + { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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" }, - "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" - } - ] + { + "description": "BirthDate\nDate on which a person was born.\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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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": { + "PrvcOfBirth": { + "allOf": [ + { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -137613,288 +90966,101 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "CtrySubDvsn": { + { + "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 - }, - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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", - "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": "CityOfBirth\nCity where a person was born.\n" + } + ] }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\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" + } }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress27", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + { + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericPersonIdentification2", + "type": "object", + "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", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "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" - ], + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", "type": "string", - "example": "ADDR" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } @@ -137908,67 +91074,15 @@ "Prtry": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -137979,122 +91093,17 @@ } ], "example": { - "Cd": "ADDR" + "Cd": "CCPT" } }, - "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": { + { + "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", @@ -138102,5417 +91111,4663 @@ "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 + { + "description": "Issuer\nEntity that assigns the identification.\n" } - }, - "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" + }, + "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", + "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", + "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", + "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", + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "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" + }, + { + "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" + }, + "TaxAmount3": { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "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": [ - "FinInstnId" + "FrDt", + "ToDt" ], "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" + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "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", + "properties": { + "Cdtr": { + "allOf": [ + { + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "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", + "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", + "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", + "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", + "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": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" + "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, - "CdtrAgt": { + "Nm": { + "allOf": [ + { + "title": "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "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", + "properties": { + "FrToDt": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FinInstnId": { + "FrDt": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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 - } - } + "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "FromDate\nStart date of the range.\n" } ] }, - "BrnchId": { + "ToDt": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" - } - } + "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": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "ToDate\nEnd date of the range.\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" - } - } + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, { - "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, - "Cdtr": { + "Tp": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "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", + "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", + "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": { - "Nm": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "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": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "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" } ] }, - "PstlAdr": { + "Ccy": { "allOf": [ { - "title": "PostalAddress27", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" - } + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] - }, - "Id": { + } + }, + "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", + "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": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", - "type": "object", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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" - } - } - } + "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": "Identification\nUnique and unambiguous identification of a party.\n" + "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" } ] }, - "CtryOfRes": { + "Ccy": { "allOf": [ { - "title": "CountryCode", + "title": "ActiveOrHistoricCurrencyCode", "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, 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": "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" }, { - "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" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] - }, - "CtctDtls": { - "allOf": [ - { - "title": "Contact13", - "description": "Specifies the details of the contact person.\n", - "type": "object", - "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": { + } + }, + "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", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "FrToDt": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", "type": "object", "properties": { - "ChanlTp": { + "FrDt": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", + "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", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "format": "date", + "example": "2013-03-07" }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "FromDate\nStart date of the range.\n" } ] }, - "Id": { + "ToDt": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", + "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", - "minLength": 1, - "maxLength": 128, - "example": 12345 + "format": "date", + "example": "2013-03-07" }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ - "ChanlTp" + "FrDt", + "ToDt" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, { - "description": "OtherContact\nContact details in another form.\n" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, - "PrefrdMtd": { + "Tp": { "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", + "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": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" ], - "example": "MAIL" + "example": "HLF1" }, { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "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": { - "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" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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": [ - "Id" + "Amt" ], "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" - } + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" } }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "Amt": { + "Amt": 100, + "Ccy": "EUR" } } }, { - "description": "Creditor\nParty to which an amount of money is due.\n" + "items": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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 }, - "CdtrAcct": { - "allOf": [ - { - "title": "CashAccount40", - "type": "object", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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", + "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", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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", + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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" + } + ] + } }, - { - "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": [ + "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" + } + ] }, - "required": [ - "IBAN" - ] + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "Prd": { + "allOf": [ { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", "properties": { - "Othr": { + "FrToDt": { "allOf": [ { - "title": "GenericAccountIdentification1", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { - "Id": { + "FrDt": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "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", - "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 - }, - { - "description": "Identification\nIdentification assigned by an institution.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "AccountSchemeName1Choice", - "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ - { - "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 - } + "format": "date", + "example": "2013-03-07" }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "FromDate\nStart date of the range.\n" } ] }, - "Issr": { + "ToDt": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "format": "date", + "example": "2013-03-07" }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ - "Id" + "FrDt", + "ToDt" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\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", - "oneOf": [ - { - "properties": { - "Cd": { + }, + "Tp": { "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", + "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", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" }, { - "description": "Code\nAccount type, in a coded form.\n" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Yr": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 }, { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, - "required": [ - "Prtry" - ] + "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" } - ], - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ + "Amt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "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": [ { - "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" - ] + "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})$" }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "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" } - ], - "example": { - "Cd": "EMAIL" - } + ] }, - { - "description": "Type\nType of the proxy identification.\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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] } - ] + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } }, - "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" - } - ] + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } - }, - "required": [ - "Id" - ], - "example": { - "Tp": { - "Cd": "IBAN" - }, - "Id": 123 + ] + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" } }, - { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "Amt": { + "Amt": 100, + "Ccy": "EUR" } - ] - } - }, - "example": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" + } }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 - } + "type": "array" } - }, - { - "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", - "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." - } + "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 }, - { - "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" - } - ] - }, - "InstrForNxtAgt": { + "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", + "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", + "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", + "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", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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", + "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", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { "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", - "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." - } + "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": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n" + "description": "FromDate\nStart date of the range.\n" } ] }, - "Purp": { + "ToDt": { "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", - "oneOf": [ - { - "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" - } + "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": "Purpose\nUnderlying reason for the payment transaction.\n" + "description": "ToDate\nEnd date of the range.\n" } ] - }, - "RgltryRptg": { + } + }, + "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", + "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", + "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": "RegulatoryReporting3", - "description": "Information needed due to regulatory and/or statutory requirements.\n", - "type": "object", - "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", - "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", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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" - } - } + "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": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" + "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" } ] }, - "Tax": { + "Ccy": { "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", - "properties": { - "Cdtr": { - "allOf": [ - { - "title": "TaxParty1", - "description": "Details about the entity involved in the tax paid or to be paid.\n", - "type": "object", - "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", - "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", - "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", - "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", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "pattern": "^[\\d\\-\\.\\,]{1,18}$", - "example": 256 - }, - { - "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", - "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", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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": { + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { "allOf": [ { - "title": "TaxAmount3", - "description": "Information on the amount of the tax record.\n", - "type": "object", - "properties": { - "Rate": { - "allOf": [ - { - "title": "PercentageRate", - "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 - }, - { - "description": "Rate\n\nRate used to calculate the tax.\n" - } - ] - }, - "TaxblBaseAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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 - } - } + "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": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" + "description": "FromDate\nStart date of the range.\n" } ] }, - "Tp": { + "ToDt": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "format": "date", + "example": "2013-03-07" }, { - "description": "Type\n\nHigh level code to identify the type of tax details.\n" + "description": "ToDate\nEnd date of the range.\n" } ] } }, + "required": [ + "FrDt", + "ToDt" + ], "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" + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, { - "items": { - "title": "TaxRecord3", - "description": "Set of elements used to define the tax record.\n", - "type": "object", - "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", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "properties": { - "Rate": { - "allOf": [ - { - "title": "PercentageRate", - "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 - }, - { - "description": "Rate\n\nRate used to calculate the tax.\n" - } - ] - }, - "TaxblBaseAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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": "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" + "description": "FromDate\nStart date of the range.\n" } ] }, - "Tp": { + "ToDt": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "format": "date", + "example": "2013-03-07" }, { - "description": "Type\n\nHigh level code to identify the type of tax details.\n" + "description": "ToDate\nEnd date of the range.\n" } ] } }, + "required": [ + "FrDt", + "ToDt" + ], "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" + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, - "type": "array" - } - ] + { + "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" + } } }, - "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 + { + "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", + "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" + } + ] }, - "Inf": 12345 + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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": "Tax\nProvides details on the tax.\n" + "description": "FromDate\nStart date of the range.\n" } ] }, - "VrfctnOfTerms": { - "title": "CryptographicLockChoice", - "description": "Cryptographically signed terms\n", - "type": "object", - "oneOf": [ + "ToDt": { + "allOf": [ { - "properties": { - "IlpV4PrepPacket": { - "allOf": [ - { - "title": "hexBinary", - "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 - }, - { - "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" - } - ] - } - }, - "required": [ - "IlpV4PrepPacket" - ] + "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" }, { - "properties": { - "Sh256Sgntr": { - "allOf": [ - { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", - "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" - }, - { - "description": "SHA-256 signature of the terms\n" - } - ] - } - }, - "required": [ - "Sh256Sgntr" - ] + "description": "ToDate\nEnd date of the range.\n" } - ], - "example": { - "IlpV4PrepPacket": "1234567890ABCDEF" - } + ] } }, "required": [ - "PmtId", - "IntrBkSttlmAmt", - "ChrgBr", - "Dbtr", - "DbtrAgt", - "CdtrAgt", - "Cdtr" + "FrDt", + "ToDt" ], "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" + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, { - "description": "Credit Transfer Transaction Information\n" + "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" } ] } }, - "required": [ - "MsgId", - "CreDtTm", - "NbOfTxs", - "SttlmInf", - "CdtTrfTxInf" - ], "example": { - "MsgId": 12345, - "CreDtTm": "2020-01-01T00:00:00Z", - "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", - "NbOfTxs": 1, - "SttlmInf": { - "SttlmMtd": "INDA", - "SttlmAcct": { - "Id": { - "IBAN": 123 + "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", + "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" } - }, - "SttlmAcctOwnr": { - "Nm": "John Doe" - }, - "SttlmAcctSvcr": { - "BICFI": 123 - } + ] }, - "CdtTrfTxInf": { - "PmtId": { - "InstrId": 123, - "EndToEndId": 123 - }, - "PmtTpInf": { - "InstrPrty": "NORM" - }, - "InstdAmt": { - "Amt": 123, - "Ccy": "EUR" - }, - "ChrgBr": "SLEV", - "CdtrAgt": { - "FinInstnId": { - "BICFI": 123 - } - }, - "Cdtr": { - "Nm": "John Doe" - }, - "CdtrAcct": { - "Id": { - "IBAN": 123 + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" } - }, - "RmtInf": { - "Ustrd": "Test" - } + ] } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "Group Header\nSet of characteristics shared by all individual transactions included in the message.\n" + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ - "GrpHdr" + "Amt" ], "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" - } + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" } } }, - "TermsResponse_FIToFICustomerCreditConfirmation": { - "title": "TermsResponse_FIToFICustomerCreditConfirmation", + "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", - "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", + "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": [ @@ -143598,2122 +95853,601 @@ "example": "CLRG" }, "PmtTpInf": { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", - "type": "object", - "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", - "oneOf": [ - { - "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", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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", - "oneOf": [ - { - "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" - } - ] - }, - "CdtTrfTxInf": { - "allOf": [ - { - "title": "CreditTransferTransaction67", - "description": "Provides further details specific to the individual transaction(s) included in the message.\n", - "type": "object", - "properties": { - "PmtId": { - "allOf": [ - { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", - "type": "object", - "properties": { - "InstrId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" - }, - { - "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", - "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", - "oneOf": [ - { - "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": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "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", + "anyOf": [ { - "title": "LocalInstrument2Choice", - "type": "object", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ - { - "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" - } - ] + "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": [ - "Prtry" ] } - ], - "example": { - "Cd": "CH03" - } + }, + "required": [ + "Cd" + ] }, { - "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", - "oneOf": [ - { - "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" - } - ] + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "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" - } - ] - }, - "IntrBkSttlmAmt": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "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", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "pattern": "^[A-Z]{3,3}$", - "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\".", - "example": "USD" - }, - { - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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" + }, + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "SEPA" + } }, - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] + { + "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 0.7 + ] }, - { - "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\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n", - "type": "string", - "enum": [ - "DEBT", - "CRED", - "SHAR", - "SLEV" - ], - "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", - "properties": { - "Amt": { - "allOf": [ + "LclInstrm": { + "allOf": [ + { + "title": "LocalInstrument2Choice", + "type": "object", + "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", + "anyOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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": { + "Cd": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "ExternalLocalInstrument1Code", + "description": "Specifies the external local instrument identification code.", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "minLength": 1, + "maxLength": 35, + "example": 12345 }, { - "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" + "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] - }, - "Ccy": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "CH03" + } }, - "Agt": { - "allOf": [ + { + "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", + "anyOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FinInstnId": { + "Cd": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ - { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", - "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", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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": "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] - }, - "BrnchId": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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" - } - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "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", + "properties": { + "PmtId": { + "allOf": [ + { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "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" + } + ] + }, + "EndToEndId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "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" + } + ] + }, + "TxId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "TransactionIdentification (FSPIOP equivalent: quoteId)\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" + } + ] + }, + "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", + "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalServiceLevel1Code", + "description": "Specifies the external service level code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, - "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": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } - } - }, - { - "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" + ] } + }, + "required": [ + "Cd" ] }, - "Tp": { - "allOf": [ - { - "title": "ChargeType3Choice", - "description": "ChargeType3Choice\nSpecifies the type of charge.\n", - "type": "object", - "oneOf": [ + { + "properties": { + "Prtry": { + "allOf": [ { - "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" - ] + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification3", - "type": "object", - "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" - ] + "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } - ], - "example": { - "Cd": "CASH" - } - }, - { - "description": "Type\nDefines the type of charges.\n" + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Amt", - "Agt" ], "example": { - "Amt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - }, - "Agt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "Tp": { - "Cd": "SHAR" - } + "Cd": "SEPA" } }, { - "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n" + "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, - "Dbtr": { + "LclInstrm": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "LocalInstrument2Choice", "type": "object", - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ - { - "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", - "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", + "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": 140, + "maxLength": 35, "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", + { + "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": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", + { + "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", + "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, - "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 + "example": 1234 }, - "CtrySubDvsn": { + { + "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", @@ -145721,404 +96455,290 @@ "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 + { + "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } - }, - "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" - } + ] + } + }, + "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" + } + ] + }, + "IntrBkSttlmAmt": { + "allOf": [ + { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "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", + "pattern": "^[A-Z]{3,3}$", + "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\".", + "example": "USD" + }, + { + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR", + "SLEV" + ], + "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", + "properties": { + "Amt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "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": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "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" } ] }, - "Id": { + "Ccy": { "allOf": [ { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", - "type": "object", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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" - } - ] + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "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" } - }, - "required": [ - "OrgId" ] }, - { - "properties": { - "PrvtId": { - "allOf": [ - { - "title": "PersonIdentification18", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ + "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", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", "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": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\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" + "maxLength": 5, + "example": 12345 }, { - "description": "CountryOfBirth\nCountry where a person was born.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" - ], - "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" - } + "Cd" + ] }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" - } - ] - }, - "Othr": { - "allOf": [ - { - "title": "GenericPersonIdentification2", - "type": "object", - "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", - "oneOf": [ - { - "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": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -146129,476 +96749,148 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nProprietary identification of the clearing system.\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" + "Prtry" + ] } - ] - } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 + ], + "example": { + "Cd": "CHIPS" } - } - } - }, - { - "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", - "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", - "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" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "Id": { + "MmbId": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 128, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "ChanlTp" + "MmbId" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "description": "OtherContact\nContact details in another form.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "PrefrdMtd": { + "LEI": { "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", + "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", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "MAIL" + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\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", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ - { - "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" - }, - { - "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" - } - ] + }, + "Nm": { + "allOf": [ + { + "title": "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" } - }, - "required": [ - "IBAN" ] }, - { - "properties": { - "Othr": { - "allOf": [ - { - "title": "GenericAccountIdentification1", + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "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" + "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" ] }, - "SchmeNm": { - "allOf": [ - { - "title": "AccountSchemeName1Choice", - "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + { + "properties": { + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "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", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 4, + "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -146609,106 +96901,84 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "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": [ - "Prtry" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - ], - "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": [ + "Prtry" ] } - }, - "required": [ - "Id" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "Cd": "ADDR" } }, - { - "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", - "oneOf": [ - { - "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", + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Code\nAccount type, in a coded form.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "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", @@ -146716,230 +96986,153 @@ "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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" - ] + "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 }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "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": { - "Cd": "EMAIL" + "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": "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "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" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "ClrSysMmbId": { + "Othr": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "GenericFinancialIdentification1", "type": "object", + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { - "ClrSysId": { + "Id": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "title": "Max35Text", + "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", - "oneOf": [ + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, - "maxLength": 5, - "example": 12345 + "maxLength": 4, + "example": 1234 }, { - "description": "Code\nClearing system identification code, as published in an external list.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } @@ -146961,7 +97154,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -146972,15 +97165,15 @@ } ], "example": { - "Cd": "CHIPS" + "Cd": "BIC" } }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "MmbId": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -146991,23 +97184,83 @@ "example": 1.234567890123457e+34 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "MmbId" + "Id" ], "example": { - "ClrSysId": { - "Cd": "CHQB" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - "MmbId": 123456789 + "Issr": "BIC" } }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "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", + "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" } ] }, @@ -147021,7 +97274,7 @@ "example": "529900T8BM49AURSDO55" }, { - "description": "LEI\nLegal entity identifier of the financial institution.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, @@ -147036,14 +97289,14 @@ "example": 12345 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { - "title": "PostalAddress24", + "title": "PostalAddress27", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -147051,7 +97304,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -147158,6 +97411,14 @@ "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", @@ -147175,12 +97436,12 @@ "example": 1.2345678901234567e+99 }, "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "maxLength": 140, + "example": 12345 }, "BldgNb": { "title": "Max16Text", @@ -147191,12 +97452,12 @@ "example": 1234567890123456 }, "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, "Flr": { "title": "Max70Text", @@ -147206,6 +97467,14 @@ "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", @@ -147231,28 +97500,28 @@ "example": 1234567890123456 }, "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", @@ -147280,12 +97549,14 @@ }, "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", @@ -147301,15 +97572,267 @@ "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", + "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 }, - "Othr": { + { + "description": "Code\nCharge type, in a coded form.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification3", + "type": "object", + "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", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "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", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "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", @@ -147320,222 +97843,1038 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ + { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "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", + "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", + "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", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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" + } }, - "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + { + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericPersonIdentification2", + "type": "object", + "description": "Identification of a person.", + "properties": { + "Id": { + "allOf": [ { - "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" - ] + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" + "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", + "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" ] } - }, - "required": [ - "Prtry" - ] + ], + "example": { + "Cd": "CCPT" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" } - ], - "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" + } + ] } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + "Issr": "BIC" + } }, - "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" }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] - } - }, - "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": "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", + "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, - "BrnchId": { + "Nm": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "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", "properties": { - "Id": { + "ChanlTp": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 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" + "maxLength": 4, + "example": 1234 }, { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "Nm": { + "Id": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, + "maxLength": 128, "example": 12345 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + "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", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "AccountIdentification4Choice", + "type": "object", + "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}$" }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress27", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + { + "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", + "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", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "description": "Sets of elements to identify a name of the identification scheme.\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" - ], + "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", - "example": "ADDR" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } @@ -147549,67 +98888,15 @@ "Prtry": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -147620,122 +98907,17 @@ } ], "example": { - "Cd": "ADDR" + "Cd": 1111 } }, - "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": { + { + "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", @@ -147743,1056 +98925,1809 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", + { + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "Tp": { + "allOf": [ + { + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + { + "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": 70, - "example": 1.2345678901234567e+99 + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nProxy account type, in a proprietary form.\n" } - }, - "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" + ] } + }, + "required": [ + "Prtry" ] } - }, + ], "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "Cd": "EMAIL" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "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": [ - "FinInstnId" + "Id" ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "Tp": { + "Cd": "IBAN" }, - "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" - } - } + "Id": 123 } }, { - "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" }, - "CdtrAgt": { + "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", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "FinancialInstitutionIdentification23", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "description": "Information used to identify a financial institution.\n", "properties": { - "FinInstnId": { + "BICFI": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "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", - "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": { + "ClrSysId": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "oneOf": [ + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ { - "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" - ] + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "description": "Code\nClearing system identification code, as published in an external list.\n" } - ], - "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" + ] } + }, + "required": [ + "Cd" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" ] } - }, - "required": [ - "MmbId" ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Cd": "CHIPS" } }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "LEI": { + "MmbId": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "LEI\nLegal entity identifier of the financial institution.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - "Nm": { - "allOf": [ + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "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" + ] }, { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "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" - ], + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "example": "ADDR" + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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": [ - "Prtry" + "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", + "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", + "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" + } ] } - ], - "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" + }, + "required": [ + "Cd" + ] }, - "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 + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": { - "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" + "Cd": "BIC" } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "Othr": { + "Issr": { "allOf": [ { - "title": "GenericFinancialIdentification1", - "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "title": "Max35Text", + "description": "Specifies a character string with a 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", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { "properties": { - "Id": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "example": "ADDR" }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "SchmeNm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "GenericIdentification30", "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ - { - "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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": [ - "Prtry" ] } + }, + "required": [ + "Id", + "Issr" ], "example": { - "Cd": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "Prtry" + ] } - ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 + ], + "example": { + "Cd": "ADDR" + } }, - "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" + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "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", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "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" } ] }, - "BrnchId": { + "ClrSysMmbId": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "properties": { - "Id": { + "ClrSysId": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "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": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "LEI": { + "MmbId": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - "Nm": { - "allOf": [ + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "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" + ] }, { - "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", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "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" - ], + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "example": "ADDR" + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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": [ - "Prtry" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - ], - "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" + ] + } + }, + "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", + "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", + "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" + ] }, - "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 + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": { - "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" + "Cd": "BIC" } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "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, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "FinInstnId" - ], + "required": [], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "BrnchId": { + "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, - "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" - } + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "Cdtr": { + "BrnchId": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "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": [ { @@ -148804,7 +100739,7 @@ "example": 12345 }, { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, @@ -148819,7 +100754,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -149084,828 +101019,670 @@ } }, { - "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", - "oneOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "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", - "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", - "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" - } - ] - } - }, - "oneOf": [ - { - "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", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "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", - "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", - "oneOf": [ - { - "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" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] - }, - "CtctDtls": { - "allOf": [ + } + }, + "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", + "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", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Contact13", - "description": "Specifies the details of the contact person.\n", - "type": "object", "properties": { - "NmPrfx": { + "Cd": { "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", + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ - "DOCT", - "MADM", - "MISS", - "MIST", - "MIKS" + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" ], "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 + "example": "ADDR" }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "Othr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "GenericIdentification30", "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "ChanlTp": { + "Id": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 4, + "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "Id": { + "Issr": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 128, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "Issuer\nEntity that assigns the identification.\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" + }, + "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" } }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "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": "Creditor\nParty to which an amount of money is due.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "CdtrAcct": { + "Id": { "allOf": [ { - "title": "CashAccount40", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", "type": "object", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", "properties": { - "IBAN": { + "AnyBIC": { "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", + "title": "AnyBICDec2014Identifier", "type": "string", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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": "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" + "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", + "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", + "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" } ] } }, - "required": [ - "IBAN" - ] + "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", "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "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": "GenericAccountIdentification1", + "title": "GenericPersonIdentification2", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 + "maxLength": 256, + "example": 256 }, { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { - "title": "AccountSchemeName1Choice", - "type": "object", + "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "type": "object", + "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", + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, @@ -149945,7 +101722,7 @@ } ], "example": { - "Cd": 1111 + "Cd": "CCPT" } }, { @@ -149975,52 +101752,659 @@ "example": { "Id": 123, "SchmeNm": { - "Cd": "IBAN" + "Cd": "DRLC" }, "Issr": "BIC" } }, { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Othr" + "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", + "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", + "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" + } ] } - ], - "example": { - "IBAN": "BE71096123456769" - } - }, - { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\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", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "AccountIdentification4Choice", + "type": "object", + "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", + "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", + "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", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { "Tp": { "allOf": [ { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", "type": "object", - "oneOf": [ + "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", + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { - "description": "Code\nAccount type, in a coded form.\n" + "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } @@ -150042,7 +102426,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } @@ -150053,811 +102437,751 @@ } ], "example": { - "Cd": "CACC" + "Cd": "EMAIL" } }, { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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" + "description": "Type\nType of the proxy identification.\n" } ] }, - "Nm": { + "Id": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 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", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "oneOf": [ - { - "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 - } + "maxLength": 2048, + "example": 2048 }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "Id": { - "IBAN": "BE71096123456769" - }, "Tp": { - "Cd": "CACC" + "Cd": "IBAN" }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 - } + "Id": 123 } }, { - "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" + "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", + "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", + "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", + "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", + "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" } ] }, - "InstrForCdtrAgt": { + "Authrty": { "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", + "title": "RegulatoryAuthority2", + "description": "Information about an entity requiring the regulatory reporting information.\n", "type": "object", "properties": { - "Cd": { + "Nm": { "allOf": [ { - "title": "ExternalCreditorAgentInstruction1Code", - "description": "Specifies the instruction given by the creditor to the creditor agent.", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 140, + "example": 12345 }, { - "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" + "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n" } ] }, - "InstrInf": { + "Ctry": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "CountryCode", "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, 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": "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" + "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n" } ] } }, "example": { - "Cd": "PHOA", - "InstrInf": "Please advise/contact next agent by phone." + "Nm": "Swiss National Bank", + "Ctry": "CH" } }, { - "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" + "description": "Authority\n\nEntity requiring the regulatory reporting information.\n" } ] }, - "InstrForNxtAgt": { - "allOf": [ + "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": "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", + "title": "StructuredRegulatoryReporting3", + "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", "type": "object", "properties": { - "Cd": { + "Tp": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "enum": [ - "PHOA", - "TELA" - ], - "example": "PHOA" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "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" + "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" } ] }, - "InstrInf": { + "Dt": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "format": "date", + "example": "2013-03-07" }, { - "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", - "oneOf": [ - { - "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" - } - ] + "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "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" } - }, - "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", - "properties": { - "DbtCdtRptgInd": { + }, + "Cd": { "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", + "title": "Max10Text", + "description": "Specifies a character string with a maximum length of 10 characters.\n", "type": "string", - "enum": [ - "CRED", - "DEBT", - "BOTH" - ], - "example": "BOTH" + "minLength": 1, + "maxLength": 10, + "example": 1234567890 }, { - "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" + "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" } ] }, - "Authrty": { + "Amt": { "allOf": [ { - "title": "RegulatoryAuthority2", - "description": "Information about an entity requiring the regulatory reporting information.\n", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", + "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": { - "Nm": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "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": "Name\n\nName of the entity requiring the regulatory reporting information.\n" + "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" } ] }, - "Ctry": { + "Ccy": { "allOf": [ { - "title": "CountryCode", + "title": "ActiveOrHistoricCurrencyCode", "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, 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": "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" }, { - "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], "example": { - "Nm": "Swiss National Bank", - "Ctry": "CH" + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "Authority\n\nEntity requiring the regulatory reporting information.\n" + "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\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", + "Inf": { + "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", "anyOf": [ { - "title": "StructuredRegulatoryReporting3", - "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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 - } + "title": "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": "StructuredRegulatoryReporting3", - "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", + "title": "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", + "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", + "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": { - "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": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "Max10Text", - "description": "Specifies a character string with a maximum length of 10 characters.\n", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "minLength": 1, - "maxLength": 10, - "example": 1234567890 + "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": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" + "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" } ] }, - "Amt": { + "Ccy": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", + "title": "ActiveOrHistoricCurrencyCode", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" }, { - "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" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], "example": { - "Tp": "T1", - "Dt": "2018-01-01", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 - }, - "Inf": 12345 + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, - "type": "array" + { + "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", + "properties": { + "Cdtr": { + "allOf": [ + { + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "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": { - "DbtCdtRptgInd": "CRED", - "Authrty": { - "Nm": "Swiss National Bank", - "Ctry": "CH" - }, - "Dtls": { - "Cd": "A1", - "Inf": "Mandatory regulatory information" - } + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT" } }, { - "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" + "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" } ] }, - "Tax": { + "Dbtr": { "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", + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "properties": { - "Cdtr": { + "TaxId": { "allOf": [ { - "title": "TaxParty1", - "description": "Details about the entity involved in the tax paid or to be paid.\n", - "type": "object", - "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" - } + "title": "Max35Text", + "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": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" + "description": "TaxType\n\nType of tax payer.\n" } ] }, - "Dbtr": { + "Authstn": { "allOf": [ { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\n", + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", "type": "object", "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": { + "Titl": { "allOf": [ { "title": "Max35Text", @@ -150868,112 +103192,112 @@ "example": 1.234567890123457e+34 }, { - "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" + "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, - "TaxTp": { + "Nm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 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", - "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" - } + "maxLength": 140, + "example": 12345 }, { - "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" + "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, "example": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT", - "Authstn": { - "Titl": "Mr", - "Nm": "John Doe" - } + "Titl": "Mr", + "Nm": "John Doe" } }, { - "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" + "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", + "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" } ] }, - "UltmtDbtr": { + "Authstn": { "allOf": [ { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\n", + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", "type": "object", "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": { + "Titl": { "allOf": [ { "title": "Max35Text", @@ -150984,105 +103308,231 @@ "example": 1.234567890123457e+34 }, { - "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" + "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, - "TaxTp": { + "Nm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 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", - "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" - } + "maxLength": 140, + "example": 12345 }, { - "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" + "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, "example": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT", - "Authstn": { - "Titl": "Mr", - "Nm": "John Doe" - } + "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" + "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", + "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" } ] }, - "AdmstnZone": { + "Ccy": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ActiveOrHistoricCurrencyCode", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "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": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n" + "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" } ] }, - "RefNb": { + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "AddtlInf": { "allOf": [ { "title": "Max140Text", @@ -151093,11 +103543,11 @@ "example": 12345 }, { - "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n" + "description": "AdditionalInformation\n\nFurther details of the tax record.\n" } ] }, - "Mtd": { + "CertId": { "allOf": [ { "title": "Max35Text", @@ -151108,422 +103558,435 @@ "example": 1.234567890123457e+34 }, { - "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n" + "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" } ] }, - "TtlTaxblBaseAmt": { + "Ctgy": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" + "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" } ] }, - "TtlTaxAmt": { + "CtgyDtls": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" + "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" } ] }, - "Dt": { + "DbtrSts": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "format": "date", - "example": "2013-03-07" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Date\n\nDate by which tax is due.\n" + "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" } ] }, - "SeqNb": { + "FrmsCd": { "allOf": [ { - "title": "Number", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[\\d\\-\\.\\,]{1,18}$", - "example": 256 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "SequenceNumber\n\nSequential number of the tax report.\n" + "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" } ] }, - "Rcrd": { - "description": "Record\n\nDetails of the tax record.\n", - "anyOf": [ + "Prd": { + "allOf": [ { - "title": "TaxRecord3", - "description": "Set of elements used to define the tax record.\n", + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", "type": "object", "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": { + "FrToDt": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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": "Category\n\nSpecifies the tax code as published by the tax authority.\n" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, - "CtgyDtls": { + "Tp": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" }, { - "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "DbtrSts": { + "Yr": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 }, { - "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] - }, - "FrmsCd": { + } + }, + "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", + "properties": { + "Rate": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "PercentageRate", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" + "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, - "Prd": { + "TaxblBaseAmt": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", + "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": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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": { + "ActiveOrHistoricCurrencyAndAmount": { "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", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" + "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": "Type\n\nIdentification of the period related to the tax payment.\n" + "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" } ] }, - "Yr": { + "Ccy": { "allOf": [ { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", + "title": "ActiveOrHistoricCurrencyCode", "type": "string", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" }, { - "description": "Year\n\nYear related to the tax payment.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, - "TaxAmt": { + "TtlAmt": { "allOf": [ { - "title": "TaxAmount3", - "description": "Information on the amount of the tax record.\n", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", + "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": { - "Rate": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "PercentageRate", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 + "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": "Rate\n\nRate used to calculate the tax.\n" + "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" } ] }, - "TaxblBaseAmt": { + "Ccy": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", "type": "object", - "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": { + "FrToDt": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" }, { - "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" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "Ccy": { + "Yr": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } } }, { - "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, - "TtlAmt": { + "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", @@ -151535,8 +103998,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -151568,760 +104031,760 @@ } }, { - "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + "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" + } }, - "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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", + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + { + "items": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", "type": "object", "properties": { - "Prd": { + "FrToDt": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", "type": "object", "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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": { + "FrDt": { "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", + "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", - "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" + "format": "date", + "example": "2013-03-07" }, { - "description": "Type\n\nIdentification of the period related to the tax payment.\n" + "description": "FromDate\nStart date of the range.\n" } ] }, - "Yr": { + "ToDt": { "allOf": [ { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", + "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", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 + "format": "date", + "example": "2013-03-07" }, { - "description": "Year\n\nYear related to the tax payment.\n" + "description": "ToDate\nEnd date of the range.\n" } ] } }, + "required": [ + "FrDt", + "ToDt" + ], "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, - "Amt": { + "Tp": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "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": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "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": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, - "required": [ - "Amt" - ], "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "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", + "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" + } + ] }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, - "type": "array" + { + "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" } - ] - } - }, - "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 + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } } - } - }, - { - "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" + }, + "type": "array" } ] } }, "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" - } + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 }, - "TaxAmt": { - "Rate": 0.2, - "TaxblBaseAmt": { - "Ccy": "EUR", + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", "Amt": 1000 }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 200 - } - }, - "AddtlInf": "VAT applicable" + "Inf": 12345 + } } }, { - "items": { - "title": "TaxRecord3", - "description": "Set of elements used to define the tax record.\n", + "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", + "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", "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": { + "FrToDt": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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": "Category\n\nSpecifies the tax code as published by the tax authority.\n" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, - "CtgyDtls": { + "Tp": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" }, { - "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "DbtrSts": { + "Yr": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 }, { - "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] - }, - "FrmsCd": { + } + }, + "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", + "properties": { + "Rate": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "PercentageRate", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" + "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, - "Prd": { + "TaxblBaseAmt": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", + "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": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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": { + "ActiveOrHistoricCurrencyAndAmount": { "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", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" + "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": "Type\n\nIdentification of the period related to the tax payment.\n" + "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" } ] }, - "Yr": { + "Ccy": { "allOf": [ { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", + "title": "ActiveOrHistoricCurrencyCode", "type": "string", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" }, { - "description": "Year\n\nYear related to the tax payment.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, - "TaxAmt": { + "TtlAmt": { "allOf": [ { - "title": "TaxAmount3", - "description": "Information on the amount of the tax record.\n", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", + "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": { - "Rate": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "PercentageRate", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 + "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": "Rate\n\nRate used to calculate the tax.\n" + "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" } ] }, - "TaxblBaseAmt": { + "Ccy": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "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", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", "type": "object", - "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": { + "FrToDt": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" }, { - "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" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "Ccy": { + "Yr": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } } }, { - "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, - "TtlAmt": { + "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", @@ -152333,8 +104796,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -152361,694 +104824,915 @@ "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", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "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" - } + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "items": { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", + "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", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", "type": "object", "properties": { - "Prd": { + "FrToDt": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", "type": "object", "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "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": { + "FrDt": { "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", + "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", - "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" + "format": "date", + "example": "2013-03-07" }, { - "description": "Type\n\nIdentification of the period related to the tax payment.\n" + "description": "FromDate\nStart date of the range.\n" } ] }, - "Yr": { + "ToDt": { "allOf": [ { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", + "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", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 + "format": "date", + "example": "2013-03-07" }, { - "description": "Year\n\nYear related to the tax payment.\n" + "description": "ToDate\nEnd date of the range.\n" } ] } }, + "required": [ + "FrDt", + "ToDt" + ], "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, - "Amt": { + "Tp": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "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", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 - }, - { - "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\".\n", - "pattern": "^[A-Z]{3,3}$", - "example": "USD" - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "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": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "example": "HLF1" }, { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "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" } ] } }, - "required": [ - "Amt" - ], "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "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", + "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" + } + ] }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" + "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\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, - "type": "array" - } - ] - } - }, - "example": { - "Rate": 0, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 0 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 0 + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } }, - "Dtls": { - "Tp": "T1", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } }, - "Inf": 12345 + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } } - } - }, - { - "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" + }, + "type": "array" } ] } }, "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" - } + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 }, - "TaxAmt": { - "Rate": 0.2, - "TaxblBaseAmt": { - "Ccy": "EUR", + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", "Amt": 1000 }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 200 - } - }, - "AddtlInf": "VAT applicable" + "Inf": 12345 + } } }, - "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 + { + "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" + } + ] + } }, - "Dt": "2018-01-01", - "SeqNb": 1, - "Rcrd": { - "Tp": "T1", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 + "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" + } }, - "Inf": 12345 + "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", + "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 with a length of 32 characters.\n", + "type": "string", + "example": "1234567890ABCDEF1234567890ABCDEF" }, { - "description": "Tax\nProvides details on the tax.\n" + "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", + "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", + "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", + "format": "datetime", + "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", + "format": "datetime", + "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", + "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" }, - "VrfctnOfTerms": { - "title": "CryptographicLockChoice", - "description": "Cryptographically signed terms\n", + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", "type": "object", - "oneOf": [ - { - "properties": { - "IlpV4PrepPacket": { - "allOf": [ + "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", + "anyOf": [ { - "title": "hexBinary", - "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 + "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" + ] }, { - "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" } - }, - "required": [ - "IlpV4PrepPacket" ] }, - { - "properties": { - "Sh256Sgntr": { - "allOf": [ + "LclInstrm": { + "allOf": [ + { + "title": "LocalInstrument2Choice", + "type": "object", + "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", + "anyOf": [ { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", - "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", - "example": "1234567890ABCDEF1234567890ABCDEF" + "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" + ] }, { - "description": "SHA-256 signature of the terms\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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", + "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" } - }, - "required": [ - "Sh256Sgntr" ] } - ], + }, "example": { - "IlpV4PrepPacket": "1234567890ABCDEF" + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } } } }, "required": [ - "PmtId", - "IntrBkSttlmAmt", - "ChrgBr", - "Dbtr", - "DbtrAgt", - "CdtrAgt", - "Cdtr" + "SttlmMtd" ], "example": { - "PmtId": { - "InstrId": "INSTRID", - "EndToEndId": "ENDTOENDID" - }, + "SttlmMtd": "INDA", "PmtTpInf": { + "InstrPrty": "NORM", + "SvcLvl": { + "Cd": "SEPA" + }, "LclInstrm": { - "Cd": "CHQB", - "Prtry": "PROPRIETARY" + "Cd": "CH03" }, - "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" + "CtgyPurp": { + "Cd": "SUPP" }, - "Agt": { - "BrnchId": { - "Id": "BRANCHID" + "Cdtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "AdrLine": "Address", + "Ctry": "CH" }, - "FinInstnId": { - "BICFI": "BICFI" + "Id": { + "OrgId": { + "AnyBIC": "BIC", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN", + "Issr": "BIC" + } + } + } + }, + "CtryOfRes": "CH", + "CtctDtls": { + "Nm": "Name", + "PhneNb": 123, + "EmailAdr": null } - }, - "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" + "description": "Settlement Information\n" } ] } @@ -153057,8 +105741,7 @@ "MsgId", "CreDtTm", "NbOfTxs", - "SttlmInf", - "CdtTrfTxInf" + "SttlmInf" ], "example": { "MsgId": 12345, @@ -153078,36 +105761,6 @@ "SttlmAcctSvcr": { "BICFI": 123 } - }, - "CdtTrfTxInf": { - "PmtId": { - "InstrId": 123, - "EndToEndId": 123 - }, - "PmtTpInf": { - "InstrPrty": "NORM" - }, - "InstdAmt": { - "Amt": 123, - "Ccy": "EUR" - }, - "ChrgBr": "SLEV", - "CdtrAgt": { - "FinInstnId": { - "BICFI": 123 - } - }, - "Cdtr": { - "Nm": "John Doe" - }, - "CdtrAcct": { - "Id": { - "IBAN": 123 - } - }, - "RmtInf": { - "Ustrd": "Test" - } } } }, @@ -153180,8 +105833,8 @@ { "title": "UUIDv4Identifier", "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + "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" @@ -153255,7 +105908,7 @@ "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -153316,7 +105969,7 @@ "title": "LocalInstrument2Choice", "type": "object", "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -153377,7 +106030,7 @@ "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -153463,8 +106116,7 @@ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", - "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "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 } ] @@ -153510,8 +106162,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -153553,8 +106205,8 @@ "title": "BaseOneRate", "type": "string", "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 0.7 + "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" @@ -153592,8 +106244,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -153670,7 +106322,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -153796,7 +106448,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -154075,7 +106727,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -154261,7 +106913,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -154586,7 +107238,7 @@ "title": "ChargeType3Choice", "description": "ChargeType3Choice\nSpecifies the type of charge.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -154738,7 +107390,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -155013,7 +107665,7 @@ "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "OrgId": { @@ -155111,7 +107763,7 @@ ] } }, - "oneOf": [ + "anyOf": [ { "properties": { "Cd": {} @@ -155307,7 +107959,7 @@ "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -155765,7 +108417,7 @@ "title": "AccountIdentification4Choice", "type": "object", "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "anyOf": [ { "properties": { "IBAN": { @@ -155774,8 +108426,8 @@ "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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" @@ -155817,7 +108469,7 @@ "title": "AccountSchemeName1Choice", "type": "object", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -155925,7 +108577,7 @@ "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -156022,7 +108674,7 @@ "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -156169,7 +108821,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -156295,7 +108947,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -156574,7 +109226,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -156760,7 +109412,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -157120,7 +109772,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -157246,7 +109898,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -157525,7 +110177,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -157711,7 +110363,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -158063,7 +110715,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -158338,7 +110990,7 @@ "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "OrgId": { @@ -158436,7 +111088,7 @@ ] } }, - "oneOf": [ + "anyOf": [ { "properties": { "Cd": {} @@ -158632,7 +111284,7 @@ "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -159090,7 +111742,7 @@ "title": "AccountIdentification4Choice", "type": "object", "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "anyOf": [ { "properties": { "IBAN": { @@ -159099,8 +111751,8 @@ "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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" @@ -159142,7 +111794,7 @@ "title": "AccountSchemeName1Choice", "type": "object", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -159250,7 +111902,7 @@ "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -159347,7 +111999,7 @@ "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -159557,7 +112209,7 @@ "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", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -159762,8 +112414,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -159912,8 +112564,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -160368,8 +113020,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -160417,8 +113069,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -160473,8 +113125,8 @@ { "title": "Number", "type": "string", - "pattern": "^[\\d\\-\\.\\,]{1,18}$", - "example": 256 + "example": 256, + "pattern": "^(?!0\\d)\\d{1,18}$" }, { "description": "SequenceNumber\n\nSequential number of the tax report.\n" @@ -160710,8 +113362,8 @@ { "title": "PercentageRate", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 + "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" @@ -160730,8 +113382,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -160779,8 +113431,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -160955,8 +113607,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -161148,8 +113800,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -161508,8 +114160,8 @@ { "title": "PercentageRate", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", - "example": 1234 + "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" @@ -161528,8 +114180,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -161577,8 +114229,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -161753,8 +114405,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -161946,8 +114598,8 @@ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", - "example": 123.45 + "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" @@ -162131,7 +114783,7 @@ "title": "CryptographicLockChoice", "description": "Cryptographically signed terms\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "IlpV4PrepPacket": { @@ -162139,8 +114791,8 @@ { "title": "hexBinary", "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 + "example": 4660, + "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" @@ -162160,7 +114812,6 @@ "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string with a length of 32 characters.\n", "type": "string", - "pattern": "^([0-9A-F][0-9A-F]){32}$", "example": "1234567890ABCDEF1234567890ABCDEF" }, { @@ -162334,14 +114985,14 @@ "UUIDv4Identifier": { "title": "UUIDv4Identifier", "type": "string", - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + "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}$" }, "VerificationReason1Choice": { "title": "VerificationReason1Choice", "type": "object", "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -162430,7 +115081,7 @@ "title": "VerificationReason1Choice", "type": "object", "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -162525,7 +115176,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -162782,7 +115433,7 @@ "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "OrgId": { @@ -162880,7 +115531,7 @@ ] } }, - "oneOf": [ + "anyOf": [ { "properties": { "Cd": {} @@ -163076,7 +115727,7 @@ "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -163524,7 +116175,7 @@ "title": "AccountIdentification4Choice", "type": "object", "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "anyOf": [ { "properties": { "IBAN": { @@ -163533,8 +116184,8 @@ "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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" @@ -163576,7 +116227,7 @@ "title": "AccountSchemeName1Choice", "type": "object", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -163684,7 +116335,7 @@ "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -163781,7 +116432,7 @@ "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -163928,7 +116579,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -164054,7 +116705,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -164333,7 +116984,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -164519,7 +117170,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -164896,7 +117547,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -165153,7 +117804,7 @@ "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "OrgId": { @@ -165251,7 +117902,7 @@ ] } }, - "oneOf": [ + "anyOf": [ { "properties": { "Cd": {} @@ -165447,7 +118098,7 @@ "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -165895,7 +118546,7 @@ "title": "AccountIdentification4Choice", "type": "object", "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "oneOf": [ + "anyOf": [ { "properties": { "IBAN": { @@ -165904,8 +118555,8 @@ "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", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", - "example": "FR1420041010050500013M02606" + "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" @@ -165947,7 +118598,7 @@ "title": "AccountSchemeName1Choice", "type": "object", "description": "Sets of elements to identify a name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -166055,7 +118706,7 @@ "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -166152,7 +118803,7 @@ "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -166299,7 +118950,7 @@ "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -166425,7 +119076,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -166704,7 +119355,7 @@ "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "description": "Specifies the name of the identification scheme.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -166890,7 +119541,7 @@ "title": "AddressType3Choice", "type": "object", "description": "Choice of formats for the type of address.\n", - "oneOf": [ + "anyOf": [ { "properties": { "Cd": { @@ -167287,7 +119938,7 @@ "hexBinary": { "title": "hexBinary", "type": "string", - "pattern": "^(0x|0X)?[a-fA-F0-9]+$", - "example": 4660 + "example": 4660, + "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" } } \ No newline at end of file diff --git a/src/fspiop/v2_0_ISO20022/openapi.ts b/src/fspiop/v2_0_ISO20022/openapi.ts index da48d1a8..aa1fe233 100644 --- a/src/fspiop/v2_0_ISO20022/openapi.ts +++ b/src/fspiop/v2_0_ISO20022/openapi.ts @@ -551,15 +551,6 @@ export interface components { }; /** * ActiveCurrencyAndAmount_SimpleType - * @description NOTE: This regex doesn't seem correct given it's xsd definition. - * - * - * - * - * - * - * - * * @example 123.45 */ ActiveCurrencyAndAmount_SimpleType: string; @@ -1663,6 +1654,7 @@ export interface components { */ FxRequest_FICreditTransferProposal: { GrpHdr: components["schemas"]["GroupHeader113"] & unknown; + CdtTrfTxInf: components["schemas"]["CreditTransferTransaction68"] & unknown; }; /** * FxResponse_FICreditTransferConfirmation @@ -2176,41 +2168,6 @@ export interface components { * "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" - * } - * }, - * "CdtrAgtAcct": { - * "Id": { - * "IBAN": "BE71096123456769" - * }, - * "Ccy": "EUR" - * }, - * "RmtInf": { - * "Ustrd": "Test" - * } * } * } */ @@ -2221,7 +2178,6 @@ export interface components { TtlIntrBkSttlmAmt?: components["schemas"]["ActiveCurrencyAndAmount"] & unknown; SttlmInf: components["schemas"]["SettlementInstruction15"] & unknown; PmtTpInf?: components["schemas"]["PaymentTypeInformation28"] & unknown; - CdtTrfTxInf: components["schemas"]["CreditTransferTransaction68"] & unknown; }; /** * GroupHeader120 @@ -2279,36 +2235,6 @@ export interface components { * "SttlmAcctSvcr": { * "BICFI": 123 * } - * }, - * "CdtTrfTxInf": { - * "PmtId": { - * "InstrId": 123, - * "EndToEndId": 123 - * }, - * "PmtTpInf": { - * "InstrPrty": "NORM" - * }, - * "InstdAmt": { - * "Amt": 123, - * "Ccy": "EUR" - * }, - * "ChrgBr": "SLEV", - * "CdtrAgt": { - * "FinInstnId": { - * "BICFI": 123 - * } - * }, - * "Cdtr": { - * "Nm": "John Doe" - * }, - * "CdtrAcct": { - * "Id": { - * "IBAN": 123 - * } - * }, - * "RmtInf": { - * "Ustrd": "Test" - * } * } * } */ @@ -2318,7 +2244,6 @@ export interface components { PmtInstrXpryDtTm?: components["schemas"]["ISODateTime"] & unknown; NbOfTxs: components["schemas"]["Max15NumericText"] & unknown; SttlmInf: components["schemas"]["SettlementInstruction15"] & unknown; - CdtTrfTxInf: components["schemas"]["CreditTransferTransaction67"] & unknown; }; /** * IBAN2007Identifier @@ -2666,11 +2591,11 @@ export interface components { OrganisationIdentificationSchemeName1Choice: { Cd?: components["schemas"]["ExternalOrganisationIdentification1Code"] & unknown; Prtry?: components["schemas"]["Max35Text"] & unknown; - } & ({ + } | { Cd?: unknown; } | { Prtry?: unknown; - }); + }; /** * OtherContact1 * @description Communication device number or electronic address used for communication. @@ -3781,6 +3706,7 @@ export interface components { */ TermsRequest_FIToFICustomerCreditProposal: { GrpHdr: components["schemas"]["GroupHeader129"] & unknown; + CdtTrfTxInf: components["schemas"]["CreditTransferTransaction67"] & unknown; }; /** * TermsResponse_FIToFICustomerCreditConfirmation