From dfd103acdd33812a5cce6765fdb84111488306a3 Mon Sep 17 00:00:00 2001 From: Kevin Leyow Date: Mon, 30 Sep 2024 13:25:14 -0500 Subject: [PATCH 01/10] chore: remove unrequired field from component --- docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml | 1 - .../openapi3/components/schemas/VerificationReport4.yaml | 5 ++--- src/fspiop/v2_0_ISO20022/json-schemas.json | 9 +++------ src/fspiop/v2_0_ISO20022/openapi.ts | 2 +- 4 files changed, 6 insertions(+), 11 deletions(-) diff --git a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml index 3516f709..45ae88db 100644 --- a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +++ b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml @@ -6589,7 +6589,6 @@ components: required: - OrgnlId - Vrfctn - - UpdtdPtyAndAcctId example: OrgnlId: 1.2345678901234568e+33 Vrfctn: true diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml index 51a33958..20310106 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml @@ -5,7 +5,7 @@ description: Provides information about the verification of party and/or account identification information. properties: - OrgnlId: + OrgnlId: allOf: - $ref: ./Max35Text.yaml - description: > @@ -45,7 +45,6 @@ properties: required: - OrgnlId - Vrfctn - - UpdtdPtyAndAcctId example: OrgnlId: 1234567890123456789012345678901234 Vrfctn: true @@ -84,4 +83,4 @@ example: AnyBIC: ABCDUS33 Othr: Id: 123456789 - Issr: ABA \ No newline at end of file + Issr: ABA diff --git a/src/fspiop/v2_0_ISO20022/json-schemas.json b/src/fspiop/v2_0_ISO20022/json-schemas.json index 3b901b05..6624e867 100644 --- a/src/fspiop/v2_0_ISO20022/json-schemas.json +++ b/src/fspiop/v2_0_ISO20022/json-schemas.json @@ -58279,8 +58279,7 @@ }, "required": [ "OrgnlId", - "Vrfctn", - "UpdtdPtyAndAcctId" + "Vrfctn" ], "example": { "OrgnlId": 1.2345678901234568e+33, @@ -67416,8 +67415,7 @@ }, "required": [ "OrgnlId", - "Vrfctn", - "UpdtdPtyAndAcctId" + "Vrfctn" ], "example": { "OrgnlId": 1.2345678901234568e+33, @@ -119881,8 +119879,7 @@ }, "required": [ "OrgnlId", - "Vrfctn", - "UpdtdPtyAndAcctId" + "Vrfctn" ], "example": { "OrgnlId": 1.2345678901234568e+33, diff --git a/src/fspiop/v2_0_ISO20022/openapi.ts b/src/fspiop/v2_0_ISO20022/openapi.ts index aa1fe233..486085ec 100644 --- a/src/fspiop/v2_0_ISO20022/openapi.ts +++ b/src/fspiop/v2_0_ISO20022/openapi.ts @@ -3825,7 +3825,7 @@ export interface components { Vrfctn: components["schemas"]["IdentificationVerificationIndicator"] & unknown; Rsn?: components["schemas"]["VerificationReason1Choice"] & unknown; OrgnlPtyAndAcctId?: components["schemas"]["IdentificationInformation4"] & unknown; - UpdtdPtyAndAcctId: components["schemas"]["IdentificationInformation4"] & unknown; + UpdtdPtyAndAcctId?: components["schemas"]["IdentificationInformation4"] & unknown; }; /** * hexBinary From b4264b7ac8bb3ec1ebf49657df512bf97d9452f2 Mon Sep 17 00:00:00 2001 From: Kevin Leyow Date: Tue, 1 Oct 2024 01:09:01 -0500 Subject: [PATCH 02/10] chore: move field out of grphdr add field to status --- ...-rest-v2.0-ISO20022-openapi3-snippets.yaml | 73 +++++--- .../schemas/DateAndDateTime2Choice.yaml | 27 +++ .../components/schemas/GroupHeader120.yaml | 27 --- ...csStatus_FIToFIPaymentStatusReportV15.yaml | 12 +- .../schemas/PaymentTransaction163.yaml | 5 + package-lock.json | 172 +++++++++--------- package.json | 4 +- src/fspiop/v2_0_ISO20022/openapi.ts | 37 ++-- 8 files changed, 190 insertions(+), 167 deletions(-) create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndDateTime2Choice.yaml diff --git a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml index 45ae88db..32dbf314 100644 --- a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +++ b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml @@ -2636,6 +2636,32 @@ components: - Sh256Sgntr example: IlpV4PrepPacket: 1234567890ABCDEF + DateAndDateTime2Choice: + title: StatusReason6Choice + description: | + Specifies the reason for the status. + type: object + anyOf: + - properties: + Dt: + allOf: + - $ref: "#/components/schemas/ISODate" + - description: | + Date + Specified date. + required: + - Dt + - properties: + DtTm: + allOf: + - $ref: "#/components/schemas/ISODateTime" + - description: | + DateTime + Specified date and time. + required: + - DtTm + example: + DtTm: "2020-01-01T00:00:00Z" DateAndPlaceOfBirth1: title: DateAndPlaceOfBirth1 description: | @@ -3928,41 +3954,12 @@ components: - description: | CreationDateTime Date and time at which the message was created. - TxInfAndSts: - allOf: - - $ref: "#/components/schemas/PaymentTransaction163" - - description: > - TransactionInformationAndStatus - - Definition: Agent that instructs the next party in the chain to - carry out the (set of) instruction(s). - - Usage: The instructing agent is the party sending the status - message and not the party that sent the original instruction - that is being reported on. 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: > @@ -4630,6 +4627,18 @@ components: - description: > Set of characteristics shared by all individual transactions included in the message. + TxInfAndSts: + allOf: + - $ref: ./PaymentTransaction163.yaml + - description: > + Information concerning the original transactions, to which the + status report message refers. + SplmtryData: + allOf: + - $ref: ./SupplementaryData1.yaml + - description: > + Additional information that cannot be captured in the + structured elements and/or any other specific block. required: - GrpHdr example: @@ -5109,6 +5118,12 @@ components: - description: > Additional information that cannot be captured in the structured elements and/or any other specific block. + PrcgDt: + allOf: + - $ref: "#/components/schemas/DateAndDateTime2Choice" + - description: > + Date/time at which the instruction was processed by the + specified party. example: StsId: 12345 OrgnlInstrId: 12345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndDateTime2Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndDateTime2Choice.yaml new file mode 100644 index 00000000..00e33f02 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndDateTime2Choice.yaml @@ -0,0 +1,27 @@ +title: StatusReason6Choice +description: | + Specifies the reason for the status. +type: object +anyOf: + - properties: + Dt: + allOf: + - $ref: ./ISODate.yaml + - description: > + Date + + Specified date. + required: + - Dt + - properties: + DtTm: + allOf: + - $ref: ./ISODateTime.yaml + - description: > + DateTime + + Specified date and time. + required: + - DtTm +example: + DtTm: '2020-01-01T00:00:00Z' diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml index bfa212b0..10f437d1 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml @@ -22,36 +22,9 @@ properties: CreationDateTime Date and time at which the message was created. - TxInfAndSts: - allOf: - - $ref: ./PaymentTransaction163.yaml - - description: > - TransactionInformationAndStatus - - Definition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s). - - Usage: The instructing agent is the party sending the status message and not the party that sent the - original instruction that is being reported on. 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 \ No newline at end of file diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml index aa3003a2..2a75d2cf 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml @@ -1,5 +1,5 @@ title: PacsStatus_FIToFIPaymentStatusReportV15 -description: +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: @@ -8,6 +8,16 @@ properties: - $ref: ./GroupHeader120.yaml - description: > Set of characteristics shared by all individual transactions included in the message. + TxInfAndSts: + allOf: + - $ref: ./PaymentTransaction163.yaml + - description: > + Information concerning the original transactions, to which the status report message refers. + SplmtryData: + allOf: + - $ref: ./SupplementaryData1.yaml + - description: > + Additional information that cannot be captured in the structured elements and/or any other specific block. required: - GrpHdr example: diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml index 3cdd7f90..ed590359 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml @@ -79,6 +79,11 @@ properties: - description: > Additional information that cannot be captured in the structured elements and/or any other specific block. + PrcgDt: + allOf: + - $ref: ./DateAndDateTime2Choice.yaml + - description: > + Date/time at which the instruction was processed by the specified party. example: StsId: 12345 OrgnlInstrId: 12345 diff --git a/package-lock.json b/package-lock.json index 03a5f892..660c9f4d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -26,8 +26,8 @@ "@redocly/openapi-cli": "^1.0.0-beta.95", "@types/jest": "^29.5.13", "@types/js-yaml": "^4.0.9", - "@typescript-eslint/eslint-plugin": "^8.7.0", - "@typescript-eslint/parser": "^8.7.0", + "@typescript-eslint/eslint-plugin": "^8.8.0", + "@typescript-eslint/parser": "^8.8.0", "audit-ci": "^7.1.0", "browser-sync": "^3.0.3", "diff": "^7.0.0", @@ -2679,16 +2679,16 @@ "dev": true }, "node_modules/@typescript-eslint/eslint-plugin": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.7.0.tgz", - "integrity": "sha512-RIHOoznhA3CCfSTFiB6kBGLQtB/sox+pJ6jeFu6FxJvqL8qRxq/FfGO/UhsGgQM9oGdXkV4xUgli+dt26biB6A==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.8.0.tgz", + "integrity": "sha512-wORFWjU30B2WJ/aXBfOm1LX9v9nyt9D3jsSOxC3cCaTQGCW5k4jNpmjFv3U7p/7s4yvdjHzwtv2Sd2dOyhjS0A==", "dev": true, "dependencies": { "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "8.7.0", - "@typescript-eslint/type-utils": "8.7.0", - "@typescript-eslint/utils": "8.7.0", - "@typescript-eslint/visitor-keys": "8.7.0", + "@typescript-eslint/scope-manager": "8.8.0", + "@typescript-eslint/type-utils": "8.8.0", + "@typescript-eslint/utils": "8.8.0", + "@typescript-eslint/visitor-keys": "8.8.0", "graphemer": "^1.4.0", "ignore": "^5.3.1", "natural-compare": "^1.4.0", @@ -2712,15 +2712,15 @@ } }, "node_modules/@typescript-eslint/parser": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.7.0.tgz", - "integrity": "sha512-lN0btVpj2unxHlNYLI//BQ7nzbMJYBVQX5+pbNXvGYazdlgYonMn4AhhHifQ+J4fGRYA/m1DjaQjx+fDetqBOQ==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.8.0.tgz", + "integrity": "sha512-uEFUsgR+tl8GmzmLjRqz+VrDv4eoaMqMXW7ruXfgThaAShO9JTciKpEsB+TvnfFfbg5IpujgMXVV36gOJRLtZg==", "dev": true, "dependencies": { - "@typescript-eslint/scope-manager": "8.7.0", - "@typescript-eslint/types": "8.7.0", - "@typescript-eslint/typescript-estree": "8.7.0", - "@typescript-eslint/visitor-keys": "8.7.0", + "@typescript-eslint/scope-manager": "8.8.0", + "@typescript-eslint/types": "8.8.0", + "@typescript-eslint/typescript-estree": "8.8.0", + "@typescript-eslint/visitor-keys": "8.8.0", "debug": "^4.3.4" }, "engines": { @@ -2740,13 +2740,13 @@ } }, "node_modules/@typescript-eslint/scope-manager": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.7.0.tgz", - "integrity": "sha512-87rC0k3ZlDOuz82zzXRtQ7Akv3GKhHs0ti4YcbAJtaomllXoSO8hi7Ix3ccEvCd824dy9aIX+j3d2UMAfCtVpg==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.8.0.tgz", + "integrity": "sha512-EL8eaGC6gx3jDd8GwEFEV091210U97J0jeEHrAYvIYosmEGet4wJ+g0SYmLu+oRiAwbSA5AVrt6DxLHfdd+bUg==", "dev": true, "dependencies": { - "@typescript-eslint/types": "8.7.0", - "@typescript-eslint/visitor-keys": "8.7.0" + "@typescript-eslint/types": "8.8.0", + "@typescript-eslint/visitor-keys": "8.8.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -2757,13 +2757,13 @@ } }, "node_modules/@typescript-eslint/type-utils": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.7.0.tgz", - "integrity": "sha512-tl0N0Mj3hMSkEYhLkjREp54OSb/FI6qyCzfiiclvJvOqre6hsZTGSnHtmFLDU8TIM62G7ygEa1bI08lcuRwEnQ==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.8.0.tgz", + "integrity": "sha512-IKwJSS7bCqyCeG4NVGxnOP6lLT9Okc3Zj8hLO96bpMkJab+10HIfJbMouLrlpyOr3yrQ1cA413YPFiGd1mW9/Q==", "dev": true, "dependencies": { - "@typescript-eslint/typescript-estree": "8.7.0", - "@typescript-eslint/utils": "8.7.0", + "@typescript-eslint/typescript-estree": "8.8.0", + "@typescript-eslint/utils": "8.8.0", "debug": "^4.3.4", "ts-api-utils": "^1.3.0" }, @@ -2781,9 +2781,9 @@ } }, "node_modules/@typescript-eslint/types": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.7.0.tgz", - "integrity": "sha512-LLt4BLHFwSfASHSF2K29SZ+ZCsbQOM+LuarPjRUuHm+Qd09hSe3GCeaQbcCr+Mik+0QFRmep/FyZBO6fJ64U3w==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.8.0.tgz", + "integrity": "sha512-QJwc50hRCgBd/k12sTykOJbESe1RrzmX6COk8Y525C9l7oweZ+1lw9JiU56im7Amm8swlz00DRIlxMYLizr2Vw==", "dev": true, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -2794,13 +2794,13 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.7.0.tgz", - "integrity": "sha512-MC8nmcGHsmfAKxwnluTQpNqceniT8SteVwd2voYlmiSWGOtjvGXdPl17dYu2797GVscK30Z04WRM28CrKS9WOg==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.8.0.tgz", + "integrity": "sha512-ZaMJwc/0ckLz5DaAZ+pNLmHv8AMVGtfWxZe/x2JVEkD5LnmhWiQMMcYT7IY7gkdJuzJ9P14fRy28lUrlDSWYdw==", "dev": true, "dependencies": { - "@typescript-eslint/types": "8.7.0", - "@typescript-eslint/visitor-keys": "8.7.0", + "@typescript-eslint/types": "8.8.0", + "@typescript-eslint/visitor-keys": "8.8.0", "debug": "^4.3.4", "fast-glob": "^3.3.2", "is-glob": "^4.0.3", @@ -2846,15 +2846,15 @@ } }, "node_modules/@typescript-eslint/utils": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.7.0.tgz", - "integrity": "sha512-ZbdUdwsl2X/s3CiyAu3gOlfQzpbuG3nTWKPoIvAu1pu5r8viiJvv2NPN2AqArL35NCYtw/lrPPfM4gxrMLNLPw==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.8.0.tgz", + "integrity": "sha512-QE2MgfOTem00qrlPgyByaCHay9yb1+9BjnMFnSFkUKQfu7adBXDTnCAivURnuPPAG/qiB+kzKkZKmKfaMT0zVg==", "dev": true, "dependencies": { "@eslint-community/eslint-utils": "^4.4.0", - "@typescript-eslint/scope-manager": "8.7.0", - "@typescript-eslint/types": "8.7.0", - "@typescript-eslint/typescript-estree": "8.7.0" + "@typescript-eslint/scope-manager": "8.8.0", + "@typescript-eslint/types": "8.8.0", + "@typescript-eslint/typescript-estree": "8.8.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -2868,12 +2868,12 @@ } }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.7.0.tgz", - "integrity": "sha512-b1tx0orFCCh/THWPQa2ZwWzvOeyzzp36vkJYOpVg0u8UVOIsfVrnuC9FqAw9gRKn+rG2VmWQ/zDJZzkxUnj/XQ==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.8.0.tgz", + "integrity": "sha512-8mq51Lx6Hpmd7HnA2fcHQo3YgfX1qbccxQOgZcb4tvasu//zXRaA1j5ZRFeCw/VRAdFi4mRM9DnZw0Nu0Q2d1g==", "dev": true, "dependencies": { - "@typescript-eslint/types": "8.7.0", + "@typescript-eslint/types": "8.8.0", "eslint-visitor-keys": "^3.4.3" }, "engines": { @@ -15150,16 +15150,16 @@ "dev": true }, "@typescript-eslint/eslint-plugin": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.7.0.tgz", - "integrity": "sha512-RIHOoznhA3CCfSTFiB6kBGLQtB/sox+pJ6jeFu6FxJvqL8qRxq/FfGO/UhsGgQM9oGdXkV4xUgli+dt26biB6A==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.8.0.tgz", + "integrity": "sha512-wORFWjU30B2WJ/aXBfOm1LX9v9nyt9D3jsSOxC3cCaTQGCW5k4jNpmjFv3U7p/7s4yvdjHzwtv2Sd2dOyhjS0A==", "dev": true, "requires": { "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "8.7.0", - "@typescript-eslint/type-utils": "8.7.0", - "@typescript-eslint/utils": "8.7.0", - "@typescript-eslint/visitor-keys": "8.7.0", + "@typescript-eslint/scope-manager": "8.8.0", + "@typescript-eslint/type-utils": "8.8.0", + "@typescript-eslint/utils": "8.8.0", + "@typescript-eslint/visitor-keys": "8.8.0", "graphemer": "^1.4.0", "ignore": "^5.3.1", "natural-compare": "^1.4.0", @@ -15167,54 +15167,54 @@ } }, "@typescript-eslint/parser": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.7.0.tgz", - "integrity": "sha512-lN0btVpj2unxHlNYLI//BQ7nzbMJYBVQX5+pbNXvGYazdlgYonMn4AhhHifQ+J4fGRYA/m1DjaQjx+fDetqBOQ==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.8.0.tgz", + "integrity": "sha512-uEFUsgR+tl8GmzmLjRqz+VrDv4eoaMqMXW7ruXfgThaAShO9JTciKpEsB+TvnfFfbg5IpujgMXVV36gOJRLtZg==", "dev": true, "requires": { - "@typescript-eslint/scope-manager": "8.7.0", - "@typescript-eslint/types": "8.7.0", - "@typescript-eslint/typescript-estree": "8.7.0", - "@typescript-eslint/visitor-keys": "8.7.0", + "@typescript-eslint/scope-manager": "8.8.0", + "@typescript-eslint/types": "8.8.0", + "@typescript-eslint/typescript-estree": "8.8.0", + "@typescript-eslint/visitor-keys": "8.8.0", "debug": "^4.3.4" } }, "@typescript-eslint/scope-manager": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.7.0.tgz", - "integrity": "sha512-87rC0k3ZlDOuz82zzXRtQ7Akv3GKhHs0ti4YcbAJtaomllXoSO8hi7Ix3ccEvCd824dy9aIX+j3d2UMAfCtVpg==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.8.0.tgz", + "integrity": "sha512-EL8eaGC6gx3jDd8GwEFEV091210U97J0jeEHrAYvIYosmEGet4wJ+g0SYmLu+oRiAwbSA5AVrt6DxLHfdd+bUg==", "dev": true, "requires": { - "@typescript-eslint/types": "8.7.0", - "@typescript-eslint/visitor-keys": "8.7.0" + "@typescript-eslint/types": "8.8.0", + "@typescript-eslint/visitor-keys": "8.8.0" } }, "@typescript-eslint/type-utils": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.7.0.tgz", - "integrity": "sha512-tl0N0Mj3hMSkEYhLkjREp54OSb/FI6qyCzfiiclvJvOqre6hsZTGSnHtmFLDU8TIM62G7ygEa1bI08lcuRwEnQ==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.8.0.tgz", + "integrity": "sha512-IKwJSS7bCqyCeG4NVGxnOP6lLT9Okc3Zj8hLO96bpMkJab+10HIfJbMouLrlpyOr3yrQ1cA413YPFiGd1mW9/Q==", "dev": true, "requires": { - "@typescript-eslint/typescript-estree": "8.7.0", - "@typescript-eslint/utils": "8.7.0", + "@typescript-eslint/typescript-estree": "8.8.0", + "@typescript-eslint/utils": "8.8.0", "debug": "^4.3.4", "ts-api-utils": "^1.3.0" } }, "@typescript-eslint/types": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.7.0.tgz", - "integrity": "sha512-LLt4BLHFwSfASHSF2K29SZ+ZCsbQOM+LuarPjRUuHm+Qd09hSe3GCeaQbcCr+Mik+0QFRmep/FyZBO6fJ64U3w==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.8.0.tgz", + "integrity": "sha512-QJwc50hRCgBd/k12sTykOJbESe1RrzmX6COk8Y525C9l7oweZ+1lw9JiU56im7Amm8swlz00DRIlxMYLizr2Vw==", "dev": true }, "@typescript-eslint/typescript-estree": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.7.0.tgz", - "integrity": "sha512-MC8nmcGHsmfAKxwnluTQpNqceniT8SteVwd2voYlmiSWGOtjvGXdPl17dYu2797GVscK30Z04WRM28CrKS9WOg==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.8.0.tgz", + "integrity": "sha512-ZaMJwc/0ckLz5DaAZ+pNLmHv8AMVGtfWxZe/x2JVEkD5LnmhWiQMMcYT7IY7gkdJuzJ9P14fRy28lUrlDSWYdw==", "dev": true, "requires": { - "@typescript-eslint/types": "8.7.0", - "@typescript-eslint/visitor-keys": "8.7.0", + "@typescript-eslint/types": "8.8.0", + "@typescript-eslint/visitor-keys": "8.8.0", "debug": "^4.3.4", "fast-glob": "^3.3.2", "is-glob": "^4.0.3", @@ -15244,24 +15244,24 @@ } }, "@typescript-eslint/utils": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.7.0.tgz", - "integrity": "sha512-ZbdUdwsl2X/s3CiyAu3gOlfQzpbuG3nTWKPoIvAu1pu5r8viiJvv2NPN2AqArL35NCYtw/lrPPfM4gxrMLNLPw==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.8.0.tgz", + "integrity": "sha512-QE2MgfOTem00qrlPgyByaCHay9yb1+9BjnMFnSFkUKQfu7adBXDTnCAivURnuPPAG/qiB+kzKkZKmKfaMT0zVg==", "dev": true, "requires": { "@eslint-community/eslint-utils": "^4.4.0", - "@typescript-eslint/scope-manager": "8.7.0", - "@typescript-eslint/types": "8.7.0", - "@typescript-eslint/typescript-estree": "8.7.0" + "@typescript-eslint/scope-manager": "8.8.0", + "@typescript-eslint/types": "8.8.0", + "@typescript-eslint/typescript-estree": "8.8.0" } }, "@typescript-eslint/visitor-keys": { - "version": "8.7.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.7.0.tgz", - "integrity": "sha512-b1tx0orFCCh/THWPQa2ZwWzvOeyzzp36vkJYOpVg0u8UVOIsfVrnuC9FqAw9gRKn+rG2VmWQ/zDJZzkxUnj/XQ==", + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.8.0.tgz", + "integrity": "sha512-8mq51Lx6Hpmd7HnA2fcHQo3YgfX1qbccxQOgZcb4tvasu//zXRaA1j5ZRFeCw/VRAdFi4mRM9DnZw0Nu0Q2d1g==", "dev": true, "requires": { - "@typescript-eslint/types": "8.7.0", + "@typescript-eslint/types": "8.8.0", "eslint-visitor-keys": "^3.4.3" } }, diff --git a/package.json b/package.json index 120d79a3..f2884731 100644 --- a/package.json +++ b/package.json @@ -100,8 +100,8 @@ "@redocly/cli": "^1.5.0", "@types/jest": "^29.5.13", "@types/js-yaml": "^4.0.9", - "@typescript-eslint/eslint-plugin": "^8.7.0", - "@typescript-eslint/parser": "^8.7.0", + "@typescript-eslint/eslint-plugin": "^8.8.0", + "@typescript-eslint/parser": "^8.8.0", "audit-ci": "^7.1.0", "browser-sync": "^3.0.3", "diff": "^7.0.0", diff --git a/src/fspiop/v2_0_ISO20022/openapi.ts b/src/fspiop/v2_0_ISO20022/openapi.ts index 486085ec..72e70318 100644 --- a/src/fspiop/v2_0_ISO20022/openapi.ts +++ b/src/fspiop/v2_0_ISO20022/openapi.ts @@ -1179,6 +1179,19 @@ export interface components { } | { Sh256Sgntr: components["schemas"]["Exact32HexBinaryText"] & unknown; }; + /** + * StatusReason6Choice + * @description Specifies the reason for the status. + * + * @example { + * "DtTm": "2020-01-01T00:00:00Z" + * } + */ + DateAndDateTime2Choice: { + Dt: components["schemas"]["ISODate"] & unknown; + } | { + DtTm: components["schemas"]["ISODateTime"] & unknown; + }; /** * DateAndPlaceOfBirth1 * @description Details about date and place of birth of a person. @@ -2185,33 +2198,12 @@ export interface components { * * @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" - * } - * } + * "CreDtTm": "2020-01-01T00:00:00Z" * } */ GroupHeader120: { MsgId: components["schemas"]["Max35Text"] & unknown; CreDtTm: components["schemas"]["ISODateTime"] & unknown; - TxInfAndSts?: components["schemas"]["PaymentTransaction163"] & unknown; }; /** * GroupHeader129 @@ -2927,6 +2919,7 @@ export interface components { ClrSysRef?: components["schemas"]["Max35Text"] & unknown; ExctnConf?: components["schemas"]["Exact32HexBinaryText"] & unknown; SplmtryData?: components["schemas"]["SupplementaryData1"] & unknown; + PrcgDt?: components["schemas"]["DateAndDateTime2Choice"] & unknown; }; /** * PaymentTypeInformation28 From 00f3c77f55d530f94832549556e0dc3016a7bd8c Mon Sep 17 00:00:00 2001 From: Kevin Leyow Date: Tue, 1 Oct 2024 01:12:04 -0500 Subject: [PATCH 03/10] chore: fix tabs --- ...-rest-v2.0-ISO20022-openapi3-snippets.yaml | 24 +- ...csStatus_FIToFIPaymentStatusReportV15.yaml | 20 +- src/fspiop/v2_0_ISO20022/json-schemas.json | 14840 +++++++--------- src/fspiop/v2_0_ISO20022/openapi.ts | 2 + src/fspiop/v2_0_ISO20022/schemas.ts | 1 + src/fspiop/v2_0_ISO20022/types.ts | 1 + 6 files changed, 6169 insertions(+), 8719 deletions(-) diff --git a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml index 32dbf314..bf3f7104 100644 --- a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +++ b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml @@ -4627,18 +4627,18 @@ components: - description: > Set of characteristics shared by all individual transactions included in the message. - TxInfAndSts: - allOf: - - $ref: ./PaymentTransaction163.yaml - - description: > - Information concerning the original transactions, to which the - status report message refers. - SplmtryData: - allOf: - - $ref: ./SupplementaryData1.yaml - - description: > - Additional information that cannot be captured in the - structured elements and/or any other specific block. + TxInfAndSts: + allOf: + - $ref: "#/components/schemas/PaymentTransaction163" + - description: > + Information concerning the original transactions, to which the + status report message refers. + SplmtryData: + allOf: + - $ref: "#/components/schemas/SupplementaryData1" + - description: > + Additional information that cannot be captured in the structured + elements and/or any other specific block. required: - GrpHdr example: diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml index 2a75d2cf..0466541e 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml @@ -8,16 +8,16 @@ properties: - $ref: ./GroupHeader120.yaml - description: > Set of characteristics shared by all individual transactions included in the message. - TxInfAndSts: - allOf: - - $ref: ./PaymentTransaction163.yaml - - description: > - Information concerning the original transactions, to which the status report message refers. - SplmtryData: - allOf: - - $ref: ./SupplementaryData1.yaml - - description: > - Additional information that cannot be captured in the structured elements and/or any other specific block. + TxInfAndSts: + allOf: + - $ref: ./PaymentTransaction163.yaml + - description: > + Information concerning the original transactions, to which the status report message refers. + SplmtryData: + allOf: + - $ref: ./SupplementaryData1.yaml + - description: > + Additional information that cannot be captured in the structured elements and/or any other specific block. required: - GrpHdr example: diff --git a/src/fspiop/v2_0_ISO20022/json-schemas.json b/src/fspiop/v2_0_ISO20022/json-schemas.json index 6624e867..fe04bc1e 100644 --- a/src/fspiop/v2_0_ISO20022/json-schemas.json +++ b/src/fspiop/v2_0_ISO20022/json-schemas.json @@ -19738,6 +19738,58 @@ "IlpV4PrepPacket": "1234567890ABCDEF" } }, + "DateAndDateTime2Choice": { + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Dt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "Date\nSpecified date.\n" + } + ] + } + }, + "required": [ + "Dt" + ] + }, + { + "properties": { + "DtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "DateTime\nSpecified date and time.\n" + } + ] + } + }, + "required": [ + "DtTm" + ] + } + ], + "example": { + "DtTm": "2020-01-01T00:00:00Z" + } + }, "DateAndPlaceOfBirth1": { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", @@ -68293,1188 +68345,1296 @@ "description": "CreationDateTime\nDate and time at which the message was created.\n" } ] + } + }, + "required": [ + "MsgId", + "CreDtTm" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z" + } + }, + "GroupHeader129": { + "title": "GroupHeader129", + "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n", + "type": "object", + "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" + } + ] }, - "TxInfAndSts": { + "CreDtTm": { "allOf": [ { - "title": "PaymentTransaction163", - "description": "Provides further details on the original transactions, to which the status report message refers.\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", + "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": { - "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" - } - ] + "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" }, - "OrgnlTxId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" }, - { - "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", + "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", - "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}$" + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" }, - { - "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 + "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" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + { + "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" + } + ] }, - { - "description": "Specifies the status of the transaction.\n" - } - ] - }, - "StsRsnInf": { - "allOf": [ - { - "title": "StatusReasonInformation14", - "description": "Unsure on description.\n", - "type": "object", - "properties": { - "Orgtr": { - "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": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", "properties": { - "Nm": { + "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\nName by which a party is known and which is usually used to identify that party.\n" + "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] - }, - "PstlAdr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] - }, - "Id": { + } + }, + "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": "Party52Choice", - "description": "NOTE: Unsure on the description.\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", + "example": 1234 + }, + { + "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nCategory purpose, in a proprietary form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + }, + { + "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + } + ] + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + } + }, + "required": [ + "SttlmMtd" + ], + "example": { + "SttlmMtd": "INDA", + "PmtTpInf": { + "InstrPrty": "NORM", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CH03" + }, + "CtgyPurp": { + "Cd": "SUPP" + }, + "Cdtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "AdrLine": "Address", + "Ctry": "CH" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN", + "Issr": "BIC" + } + } + } + }, + "CtryOfRes": "CH", + "CtctDtls": { + "Nm": "Name", + "PhneNb": 123, + "EmailAdr": null + } + } + } + } + }, + { + "description": "Settlement Information\n" + } + ] + } + }, + "required": [ + "MsgId", + "CreDtTm", + "NbOfTxs", + "SttlmInf" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z", + "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "SttlmInf": { + "SttlmMtd": "INDA", + "SttlmAcct": { + "Id": { + "IBAN": 123 + } + }, + "SttlmAcctOwnr": { + "Nm": "John Doe" + }, + "SttlmAcctSvcr": { + "BICFI": 123 + } + } + } + }, + "IBAN2007Identifier": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "example": "FR1420041010050500013M02606", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" + }, + "ISODate": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ISODateTime": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "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", + "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": { - "OrgId": { + "Cd": { "allOf": [ { - "title": "OrganisationIdentification39", - "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": "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" - } - }, - { - "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" - } + "title": "Max35Text", + "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": "SchemeName\nShort textual description of the scheme.\n" } ] } }, + "required": [ + "Id", + "Issr" + ], "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ - "PrvtId" + "Prtry" ] } ], "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } + "Cd": "ADDR" } }, - { - "description": "Identification\nUnique and unambiguous identification of a party.\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": "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" + "AdrLine": { + "title": "Max70Text", + "description": "Specifies 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": [ + { + "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": "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": { + "OrgId": { "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", + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "properties": { - "ChanlTp": { + "AnyBIC": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", + "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": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, - "Id": { + "LEI": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 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": 128, - "example": 12345 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "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": [ - "ChanlTp" - ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } } }, { - "description": "OtherContact\nContact details in another form.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] - }, - "PrefrdMtd": { + } + }, + "required": [ + "OrgId" + ] + }, + { + "properties": { + "PrvtId": { "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" + "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": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\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": [ + "PrvtId" + ] } - ] - } - }, - "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" + ], + "example": { + "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 way to identify an organisation.\n" } - } + ] }, - { - "description": "Originator\nParty that issues the status.\n" - } - ] - }, - "Rsn": { - "allOf": [ - { - "title": "StatusReason6Choice", - "description": "Specifies the reason for the status.\n", - "type": "object", - "anyOf": [ + "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": "ExternalStatusReason1Code", - "description": "Specifies the external status 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 for the status, 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", @@ -69485,1097 +69645,265 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nReason for the status, in a proprietary 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" } - ], - "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 + }, + "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": "AdditionalInformation\nAdditional information about the status report.\n" + "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" } - ] - } - }, - "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" + { + "description": "Party\nIdentification of a person or an organisation.\n" + } + ] } + }, + "required": [ + "Pty" ] }, - "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", - "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" - } - } - } - }, - "required": [ - "SttlmMtd" - ], - "example": { - "SttlmMtd": "INDA", - "PmtTpInf": { - "InstrPrty": "NORM", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CH03" - }, - "CtgyPurp": { - "Cd": "SUPP" - }, - "Cdtr": { - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "AdrLine": "Address", - "Ctry": "CH" - }, - "Id": { - "OrgId": { - "AnyBIC": "BIC", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN", - "Issr": "BIC" - } - } - } - }, - "CtryOfRes": "CH", - "CtctDtls": { - "Nm": "Name", - "PhneNb": 123, - "EmailAdr": null - } - } - } - } - }, - { - "description": "Settlement Information\n" - } - ] - } - }, - "required": [ - "MsgId", - "CreDtTm", - "NbOfTxs", - "SttlmInf" - ], - "example": { - "MsgId": 12345, - "CreDtTm": "2020-01-01T00:00:00Z", - "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", - "NbOfTxs": 1, - "SttlmInf": { - "SttlmMtd": "INDA", - "SttlmAcct": { - "Id": { - "IBAN": 123 - } - }, - "SttlmAcctOwnr": { - "Nm": "John Doe" - }, - "SttlmAcctSvcr": { - "BICFI": 123 - } - } - } - }, - "IBAN2007Identifier": { - "title": "IBAN2007Identifier", - "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", - "type": "string", - "example": "FR1420041010050500013M02606", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" - }, - "ISODate": { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - "ISODateTime": { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "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", - "anyOf": [ { "properties": { - "Pty": { + "Agt": { "allOf": [ { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "Nm": { + "FinInstnId": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies 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", + "title": "FinancialInstitutionIdentification18", "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", - "anyOf": [ + "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" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "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": [ + "anyOf": [ { - "title": "GenericOrganisationIdentification1", - "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": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\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" - } + "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", @@ -70586,226 +69914,401 @@ "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": "BIC" - }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + "Prtry" + ] } - ] - } - }, - "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" + ], + "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": "Organisation\nUnique and unambiguous way to identify an organisation.\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" } - }, - "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" - } - ] + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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" }, - "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": "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": "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 + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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": "CityOfBirth\nCity where a person was born.\n" + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] } - ] + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } }, - "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" - } - ] + { + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + ] } + }, + "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 }, - "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": "GenericPersonIdentification1", - "type": "object", - "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { - "Id": { + "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": "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" - } + "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", @@ -70816,506 +70319,113 @@ "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": "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" - } - ] + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] } }, "required": [ - "ChanlTp" + "Id" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "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": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, + "required": [], "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "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": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\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": { + "BrnchId": { "allOf": [ { - "title": "FinancialInstitutionIdentification18", + "title": "BranchData3", "type": "object", - "description": "Information used to identify a financial institution.\n", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { - "BICFI": { + "Id": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "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 - } + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, @@ -71329,7 +70439,7 @@ "example": "529900T8BM49AURSDO55" }, { - "description": "LEI\nLegal entity identifier of the financial institution.\n" + "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, @@ -71344,7 +70454,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 an agent is known and which is usually used to identify that agent.\n" } ] }, @@ -71606,472 +70716,7 @@ } }, { - "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" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } @@ -74142,3215 +72787,920 @@ } } }, - { - "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" - } - ] - }, - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\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": 4, - "example": 1234 - }, - { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 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", - "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": "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" - } - ] - } - }, - "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", - "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" - } - } - } - }, - "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" - } - ] - }, - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\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": {} - } + { + "description": "Agent\nIdentification of a financial institution.\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": [ + "Agt" ] } - }, - "required": [ - "Id" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" + "Pty": { + "Nm": "Name", + "PstlAdr": { + "Ctry": "US", + "AdrLine": [ + "Line1", + "Line2" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + } + } }, - "Issr": "BIC" + "Agt": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } } }, { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\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": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" + "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" + } + } } } }, - "OrganisationIdentification39": { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", + "IdentificationInformation4": { + "title": "IdentificationInformation4", "type": "object", + "description": "Information that locates and identifies a specific party or account.\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": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": { + "Pty": { "allOf": [ { - "title": "GenericOrganisationIdentification3", + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", - "description": "Information related to an identification of an organisation.\n", "properties": { - "Id": { + "Nm": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 256, - "example": 256 + "maxLength": 140, + "example": 12345 }, { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, - "SchmeNm": { + "PstlAdr": { "allOf": [ { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", + "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": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification code.", - "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": "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 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\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" + } + ] + }, + "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" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\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" ] - } - }, - "anyOf": [ - { - "properties": { - "Cd": {} - } }, { "properties": { - "Prtry": {} - } + "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": "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 + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } }, { - "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" + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, - "CreDtTm": { + "CtryOfRes": { "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", + "title": "CountryCode", "type": "string", - "format": "datetime", - "example": "2013-03-07T14:44:30.000Z" + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { - "description": "CreationDateTime\nDate and time at which the message was created.\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" } ] }, - "TxInfAndSts": { + "CtctDtls": { "allOf": [ { - "title": "PaymentTransaction163", - "description": "Provides further details on the original transactions, to which the status report message refers.\n", + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", "type": "object", "properties": { - "StsId": { + "NmPrfx": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 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": 35, - "example": 1.234567890123457e+34 + "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": "Unique identification, as assigned by the original sending party, to unambiguously identify the status report.\n" + "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" } ] }, - "OrgnlInstrId": { + "EmailPurp": { "allOf": [ { "title": "Max35Text", @@ -77361,11 +73711,11 @@ "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" + "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, - "OrgnlEndToEndId": { + "JobTitl": { "allOf": [ { "title": "Max35Text", @@ -77376,11 +73726,11 @@ "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" + "description": "JobTitle\nTitle of the function.\n" } ] }, - "OrgnlTxId": { + "Rspnsblty": { "allOf": [ { "title": "Max35Text", @@ -77391,1113 +73741,998 @@ "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" + "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" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 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" ] }, - "OrgnlUETR": { + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "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}$" + "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": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n" + "description": "Type\nType of the proxy identification.\n" } ] }, - "TxSts": { + "Id": { "allOf": [ { - "title": "ExternalPaymentTransactionStatus1Code", - "description": "Specifies the external payment transaction status code.", + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 2048, + "example": 2048 }, { - "description": "Specifies the status of the transaction.\n" + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\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" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "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" - ] + } + }, + "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 }, { - "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" - ] + "description": "Code\nClearing system identification code, as published in an external list.\n" } - ], - "example": { - "OrgId": { - "AnyBIC": "BIC" + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + { + "description": "Proprietary\nProprietary identification of the clearing system.\n" } - } - }, - { - "description": "Identification\nUnique and unambiguous identification of a party.\n" + ] } + }, + "required": [ + "Prtry" ] - }, - "CtryOfRes": { + } + ], + "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": [ { - "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": "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": { - "allOf": [ - { - "title": "Max35Text", - "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", - "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": "JobTitle\nTitle of the function.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "Rspnsblty": { + "Issr": { "allOf": [ { "title": "Max35Text", "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 - } + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "OtherContact\nContact details in another form.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "PrefrdMtd": { + "SchmeNm": { "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": "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" - } - } + "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": "Originator\nParty that issues the status.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Rsn": { + "SchmeNm": { "allOf": [ { - "title": "StatusReason6Choice", - "description": "Specifies the reason for the status.\n", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", + "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalStatusReason1Code", - "description": "Specifies the external status reason code.", + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { - "description": "Code\nReason for the status, as published in an external reason code list.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } @@ -78519,7 +74754,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nReason for the status, in a proprietary form.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -78530,71 +74765,837 @@ } ], "example": { - "Cd": "AGNT" + "Cd": "BIC" } }, { - "description": "Reason\nSpecifies the reason for the status report.\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": "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 }, - "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" - } - ] + "PstCd": { + "title": "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": { - "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" + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "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": "Information concerning the reason for the status.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] - }, - "AccptncDtTm": { + } + }, + "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": "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", + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", "type": "string", - "format": "datetime", - "example": "2013-03-07T14:44:30.000Z" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "Date and time at which the status was accepted.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, - "AcctSvcrRef": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -78605,113 +75606,370 @@ "example": 1.234567890123457e+34 }, { - "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] + } + }, + "anyOf": [ + { + "properties": { + "Cd": {} + } }, - "ClrSysRef": { + { + "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": "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 + "maxLength": 4, + "example": 1234 }, { - "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, - "ExctnConf": { + "Prtry": { "allOf": [ { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 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" - } - } + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\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" + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } } + ], + "example": { + "Cd": "BIC" } }, { - "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" + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "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" } ] } @@ -78722,27 +75980,7 @@ ], "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" - } - } + "CreDtTm": "2020-01-01T00:00:00Z" } }, { @@ -80109,6 +77347,65 @@ "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" } ] + }, + "PrcgDt": { + "allOf": [ + { + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Dt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "Date\nSpecified date.\n" + } + ] + } + }, + "required": [ + "Dt" + ] + }, + { + "properties": { + "DtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "DateTime\nSpecified date and time.\n" + } + ] + } + }, + "required": [ + "DtTm" + ] + } + ], + "example": { + "DtTm": "2020-01-01T00:00:00Z" + } + }, + { + "description": "Date/time at which the instruction was processed by the specified party.\n" + } + ] } }, "example": { @@ -80250,554 +77547,532 @@ "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" + "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" + } + ] + } + }, + "required": [ + "MsgId", + "CreDtTm" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z" + } + }, + { + "description": "Set of characteristics shared by all individual transactions included in the message.\n" + } + ] + }, + "TxInfAndSts": { + "allOf": [ + { + "title": "PaymentTransaction163", + "description": "Provides further details on the original transactions, to which the status report message refers.\n", + "type": "object", + "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" } ] }, - "CreDtTm": { + "OrgnlTxId": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "format": "datetime", - "example": "2013-03-07T14:44:30.000Z" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "CreationDateTime\nDate and time at which the message was created.\n" + "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" } ] }, - "TxInfAndSts": { + "StsRsnInf": { "allOf": [ { - "title": "PaymentTransaction163", - "description": "Provides further details on the original transactions, to which the status report message refers.\n", + "title": "StatusReasonInformation14", + "description": "Unsure on description.\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": { + "Orgtr": { "allOf": [ { - "title": "StatusReasonInformation14", - "description": "Unsure on description.\n", + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "properties": { - "Orgtr": { + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies 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": "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", - "anyOf": [ + "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" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies 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": [ + "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 }, - "Id": { - "allOf": [ - { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", - "type": "object", - "anyOf": [ + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "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": { - "OrgId": { + "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": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", + "title": "GenericOrganisationIdentification3", "type": "object", + "description": "Information related to an identification of 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": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 256, + "example": 256 }, { - "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + "description": "Identification\nIdentification assigned by an institution.\n" } ] }, - "Othr": { + "SchmeNm": { "allOf": [ { - "title": "GenericOrganisationIdentification3", + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", "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", + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", "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" - } + "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", @@ -80808,885 +78083,997 @@ "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": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", "properties": { - "PrvtId": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "PersonIdentification18", - "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": "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": [ + "title": "Max35Text", + "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": [ { - "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": "Person\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": "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": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, - "CtryOfRes": { + "Nm": { "allOf": [ { - "title": "CountryCode", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 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": 140, + "example": 12345 }, { - "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": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, - "CtctDtls": { + "PhneNb": { "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" - } + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\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" + "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" } - } + ] }, - "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 + "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": "Code\nReason for the status, as published in an external reason code list.\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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "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": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "AGNT" + "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": "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" + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "Orgtr": { - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "SubDepartment", - "StrtNm": "StreetName", - "BldgNb": "BuildingNumber", - "PstCd": "PostCode", - "TwnNm": "TownName", - "CtrySubDvsn": "CountrySubDivision", - "Ctry": "Country" - } + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" }, - "Rsn": { - "Cd": "AGNT" + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } }, - "AddtlInf": "AdditionalInformation" + "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": "Information concerning the reason for the status.\n" + "description": "Originator\nParty that issues the status.\n" } ] }, - "AccptncDtTm": { + "Rsn": { "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": "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": "Date and time at which the status was accepted.\n" + "description": "Reason\nSpecifies the reason for the status report.\n" } ] }, - "AcctSvcrRef": { + "AddtlInf": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 105, + "example": 12345 }, { - "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\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" + } }, - "ClrSysRef": { + "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": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 350, + "example": 350 }, { - "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" + "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" } ] }, - "ExctnConf": { + "Envlp": { "allOf": [ { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", - "type": "string", - "example": "1234567890ABCDEF1234567890ABCDEF" + "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": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n" + "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" } ] - }, - "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" - } - ] + } + }, + "required": [ + "Envlp" + ], + "example": { + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } + } + }, + { + "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" + } + ] + }, + "PrcgDt": { + "allOf": [ + { + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Dt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" }, - "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" - } - ] + { + "description": "Date\nSpecified date.\n" } - }, - "required": [ - "Envlp" - ], - "example": { - "PlcAndNm": "Additional information", - "Envlp": { - "Cd": "CH03", - "Prtry": "Additional information" + ] + } + }, + "required": [ + "Dt" + ] + }, + { + "properties": { + "DtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "DateTime\nSpecified date and time.\n" } - } - }, - { - "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" + ] } + }, + "required": [ + "DtTm" ] } - }, + ], "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" - } + "DtTm": "2020-01-01T00:00:00Z" } }, { - "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" + "description": "Date/time at which the instruction was processed by the specified party.\n" + } + ] + } + }, + "example": { + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" + }, + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" + } + } + }, + { + "description": "Information concerning the original transactions, to which the status report message refers.\n" + } + ] + }, + "SplmtryData": { + "allOf": [ + { + "title": "SupplementaryData1", + "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "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": [ - "MsgId", - "CreDtTm" + "Envlp" ], "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" - } + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" } } }, { - "description": "Set of characteristics shared by all individual transactions included in the message.\n" + "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" } ] } @@ -88077,6 +85464,65 @@ "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" } ] + }, + "PrcgDt": { + "allOf": [ + { + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Dt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "Date\nSpecified date.\n" + } + ] + } + }, + "required": [ + "Dt" + ] + }, + { + "properties": { + "DtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "DateTime\nSpecified date and time.\n" + } + ] + } + }, + "required": [ + "DtTm" + ] + } + ], + "example": { + "DtTm": "2020-01-01T00:00:00Z" + } + }, + { + "description": "Date/time at which the instruction was processed by the specified party.\n" + } + ] } }, "example": { diff --git a/src/fspiop/v2_0_ISO20022/openapi.ts b/src/fspiop/v2_0_ISO20022/openapi.ts index 72e70318..27e75622 100644 --- a/src/fspiop/v2_0_ISO20022/openapi.ts +++ b/src/fspiop/v2_0_ISO20022/openapi.ts @@ -2677,6 +2677,8 @@ export interface components { */ PacsStatus_FIToFIPaymentStatusReportV15: { GrpHdr: components["schemas"]["GroupHeader120"] & unknown; + TxInfAndSts?: components["schemas"]["PaymentTransaction163"] & unknown; + SplmtryData?: components["schemas"]["SupplementaryData1"] & unknown; }; /** * Party38Choice diff --git a/src/fspiop/v2_0_ISO20022/schemas.ts b/src/fspiop/v2_0_ISO20022/schemas.ts index 20a44257..3975b4dd 100644 --- a/src/fspiop/v2_0_ISO20022/schemas.ts +++ b/src/fspiop/v2_0_ISO20022/schemas.ts @@ -37,6 +37,7 @@ export namespace Schemas { export const CreditTransferTransaction67 = JsonSchemas.CreditTransferTransaction67 export const CreditTransferTransaction68 = JsonSchemas.CreditTransferTransaction68 export const CryptographicLockChoice = JsonSchemas.CryptographicLockChoice + export const DateAndDateTime2Choice = JsonSchemas.DateAndDateTime2Choice export const DateAndPlaceOfBirth1 = JsonSchemas.DateAndPlaceOfBirth1 export const DatePeriod2 = JsonSchemas.DatePeriod2 export const ErrorCode = JsonSchemas.ErrorCode diff --git a/src/fspiop/v2_0_ISO20022/types.ts b/src/fspiop/v2_0_ISO20022/types.ts index 41a2c755..0520bef9 100644 --- a/src/fspiop/v2_0_ISO20022/types.ts +++ b/src/fspiop/v2_0_ISO20022/types.ts @@ -37,6 +37,7 @@ export namespace Types { export type CreditTransferTransaction67 = components['schemas']['CreditTransferTransaction67'] export type CreditTransferTransaction68 = components['schemas']['CreditTransferTransaction68'] export type CryptographicLockChoice = components['schemas']['CryptographicLockChoice'] + export type DateAndDateTime2Choice = components['schemas']['DateAndDateTime2Choice'] export type DateAndPlaceOfBirth1 = components['schemas']['DateAndPlaceOfBirth1'] export type DatePeriod2 = components['schemas']['DatePeriod2'] export type ErrorCode = components['schemas']['ErrorCode'] From 3acdd6d68f3ea3c6d97c5ca21ab1026b4258b42e Mon Sep 17 00:00:00 2001 From: Kevin Leyow Date: Tue, 1 Oct 2024 15:23:47 -0500 Subject: [PATCH 04/10] chore: add component --- ...-rest-v2.0-ISO20022-openapi3-snippets.yaml | 42 +- .../schemas/CreditTransferTransaction67.yaml | 9 +- .../schemas/CreditTransferTransaction68.yaml | 11 +- ...ExternalPaymentTransactionStatus1Code.yaml | 14 +- .../schemas/PaymentIdentification13.yaml | 3 +- .../UnderlyingCustomerCreditTransfer.yaml | 11 + src/fspiop/v2_0_ISO20022/json-schemas.json | 585 +++++++++++++++++- src/fspiop/v2_0_ISO20022/openapi.ts | 18 +- src/fspiop/v2_0_ISO20022/schemas.ts | 1 + src/fspiop/v2_0_ISO20022/types.ts | 1 + 10 files changed, 667 insertions(+), 28 deletions(-) create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/UnderlyingCustomerCreditTransfer.yaml diff --git a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml index bf3f7104..a952d85f 100644 --- a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +++ b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml @@ -2288,6 +2288,12 @@ components: - description: | PaymentTypeInformation Set of elements used to further specify the type of transaction. + UndrlygCstmrCdtTrf: + allOf: + - $ref: "#/components/schemas/UnderlyingCustomerCreditTransfer" + - description: | + Underlying Customer Credit Transfer + TBD IntrBkSttlmAmt: allOf: - $ref: "#/components/schemas/ActiveCurrencyAndAmount" @@ -2502,6 +2508,12 @@ components: - description: | PaymentTypeInformation Set of elements used to further specify the type of transaction. + UndrlygCstmrCdtTrf: + allOf: + - $ref: "#/components/schemas/UnderlyingCustomerCreditTransfer" + - description: | + Underlying Customer Credit Transfer + TBD IntrBkSttlmAmt: allOf: - $ref: "#/components/schemas/ActiveCurrencyAndAmount" @@ -2952,11 +2964,21 @@ components: example: 1234 ExternalPaymentTransactionStatus1Code: title: ExternalPaymentTransactionStatus1Code - description: Specifies the external payment transaction status code. + description: | + Specifies the external payment transaction status code. + + For FSPIOP transfer state enumeration mappings: + { + "COMM": "COMMITED", + "RESV": "RESERVED", + "RECV": "RECEIVED", + "ABOR": "ABORTED", + "SETT": "SETTLED" + } type: string minLength: 1 maxLength: 4 - example: 1234 + example: SETT ExternalPersonIdentification1Code: title: ExternalPersonIdentification1Code description: Specifies the external person identification code. @@ -4983,7 +5005,8 @@ components: allOf: - $ref: "#/components/schemas/Max35Text" - description: > - TransactionIdentification (FSPIOP equivalent: quoteId) + TransactionIdentification (FSPIOP equivalent: quoteId in quote + request, transferId in transfer request) Definition: Unique identification, as assigned by the first @@ -6522,6 +6545,19 @@ components: example: 8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e pattern: >- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ + UnderlyingCustomerCreditTransfer: + title: UnderlyingCustomerCreditTransfer + type: object + properties: + InstdAmt: + allOf: + - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" + - description: > + InstructedAmount + + Amount of money to be moved between the debtor and creditor, + before deduction of charges, expressed in the currency as + ordered by the initiating party. VerificationReason1Choice: title: VerificationReason1Choice type: object diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml index ee8fbca0..262f2b5b 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml @@ -18,6 +18,13 @@ properties: PaymentTypeInformation Set of elements used to further specify the type of transaction. + UndrlygCstmrCdtTrf: + allOf: + - $ref: ./UnderlyingCustomerCreditTransfer.yaml + - description: > + Underlying Customer Credit Transfer + + TBD IntrBkSttlmAmt: allOf: - $ref: ./ActiveCurrencyAndAmount.yaml @@ -212,4 +219,4 @@ example: Dbtr: TRUE Cdtr: TRUE Tax: - Cdtr \ No newline at end of file + Cdtr diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml index be5119b5..60036999 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml @@ -16,8 +16,15 @@ properties: - $ref: ./PaymentTypeInformation28.yaml - description: > PaymentTypeInformation - + Set of elements used to further specify the type of transaction. + UndrlygCstmrCdtTrf: + allOf: + - $ref: ./UnderlyingCustomerCreditTransfer.yaml + - description: > + Underlying Customer Credit Transfer + + TBD IntrBkSttlmAmt: allOf: - $ref: ./ActiveCurrencyAndAmount.yaml @@ -126,4 +133,4 @@ example: Cd: CHAR VrfctnOfTerms: Cntt: CONTENT - CnttTp: PROPRIETARY \ No newline at end of file + CnttTp: PROPRIETARY diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml index 7f0195be..cc74c420 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml @@ -1,6 +1,16 @@ title: ExternalPaymentTransactionStatus1Code -description: Specifies the external payment transaction status code. +description: | + Specifies the external payment transaction status code. + + For FSPIOP transfer state enumeration mappings: + { + "COMM": "COMMITED", + "RESV": "RESERVED", + "RECV": "RECEIVED", + "ABOR": "ABORTED", + "SETT": "SETTLED" + } type: string minLength: 1 maxLength: 4 -example: 1234 +example: SETT diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml index 8b9681bd..4d16c9e1 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml @@ -33,7 +33,7 @@ properties: allOf: - $ref: ./Max35Text.yaml - description: | - TransactionIdentification (FSPIOP equivalent: quoteId) + TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request) Definition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. @@ -65,4 +65,3 @@ example: TxId: TRANSACTIONID UETR: 123e4567-e89b-12d3-a456-426614174000 ClrSysRef: CLRSYSREF - \ No newline at end of file diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/UnderlyingCustomerCreditTransfer.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/UnderlyingCustomerCreditTransfer.yaml new file mode 100644 index 00000000..eab4fb74 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/UnderlyingCustomerCreditTransfer.yaml @@ -0,0 +1,11 @@ +title: UnderlyingCustomerCreditTransfer +type: object +properties: + InstdAmt: + allOf: + - $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml + - description: > + InstructedAmount + + Amount of money to be moved between the debtor and creditor, + before deduction of charges, expressed in the currency as ordered by the initiating party. diff --git a/src/fspiop/v2_0_ISO20022/json-schemas.json b/src/fspiop/v2_0_ISO20022/json-schemas.json index fe04bc1e..9fbe1f0e 100644 --- a/src/fspiop/v2_0_ISO20022/json-schemas.json +++ b/src/fspiop/v2_0_ISO20022/json-schemas.json @@ -5409,7 +5409,7 @@ "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": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" } ] }, @@ -5689,6 +5689,68 @@ } ] }, + "UndrlygCstmrCdtTrf": { + "allOf": [ + { + "title": "UnderlyingCustomerCreditTransfer", + "type": "object", + "properties": { + "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" + } + ] + } + } + }, + { + "description": "Underlying Customer Credit Transfer\nTBD\n" + } + ] + }, "IntrBkSttlmAmt": { "allOf": [ { @@ -14580,7 +14642,7 @@ "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": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" } ] }, @@ -14860,6 +14922,68 @@ } ] }, + "UndrlygCstmrCdtTrf": { + "allOf": [ + { + "title": "UnderlyingCustomerCreditTransfer", + "type": "object", + "properties": { + "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" + } + ] + } + } + }, + { + "description": "Underlying Customer Credit Transfer\nTBD\n" + } + ] + }, "IntrBkSttlmAmt": { "allOf": [ { @@ -20525,7 +20649,7 @@ "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": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" } ] }, @@ -20805,6 +20929,68 @@ } ] }, + "UndrlygCstmrCdtTrf": { + "allOf": [ + { + "title": "UnderlyingCustomerCreditTransfer", + "type": "object", + "properties": { + "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" + } + ] + } + } + }, + { + "description": "Underlying Customer Credit Transfer\nTBD\n" + } + ] + }, "IntrBkSttlmAmt": { "allOf": [ { @@ -29859,11 +30045,11 @@ }, "ExternalPaymentTransactionStatus1Code": { "title": "ExternalPaymentTransactionStatus1Code", - "description": "Specifies the external payment transaction status code.", + "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\",\n \"SETT\": \"SETTLED\"\n}\n", "type": "string", "minLength": 1, "maxLength": 4, - "example": 1234 + "example": "SETT" }, "ExternalPersonIdentification1Code": { "title": "ExternalPersonIdentification1Code", @@ -31806,7 +31992,7 @@ "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": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" } ] }, @@ -32086,6 +32272,68 @@ } ] }, + "UndrlygCstmrCdtTrf": { + "allOf": [ + { + "title": "UnderlyingCustomerCreditTransfer", + "type": "object", + "properties": { + "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" + } + ] + } + } + }, + { + "description": "Underlying Customer Credit Transfer\nTBD\n" + } + ] + }, "IntrBkSttlmAmt": { "allOf": [ { @@ -37763,7 +38011,7 @@ "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": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" } ] }, @@ -38043,6 +38291,68 @@ } ] }, + "UndrlygCstmrCdtTrf": { + "allOf": [ + { + "title": "UnderlyingCustomerCreditTransfer", + "type": "object", + "properties": { + "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" + } + ] + } + } + }, + { + "description": "Underlying Customer Credit Transfer\nTBD\n" + } + ] + }, "IntrBkSttlmAmt": { "allOf": [ { @@ -43436,7 +43746,7 @@ "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": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" } ] }, @@ -43716,6 +44026,68 @@ } ] }, + "UndrlygCstmrCdtTrf": { + "allOf": [ + { + "title": "UnderlyingCustomerCreditTransfer", + "type": "object", + "properties": { + "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" + } + ] + } + } + }, + { + "description": "Underlying Customer Credit Transfer\nTBD\n" + } + ] + }, "IntrBkSttlmAmt": { "allOf": [ { @@ -76072,11 +76444,11 @@ "allOf": [ { "title": "ExternalPaymentTransactionStatus1Code", - "description": "Specifies the external payment transaction status code.", + "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\",\n \"SETT\": \"SETTLED\"\n}\n", "type": "string", "minLength": 1, "maxLength": 4, - "example": 1234 + "example": "SETT" }, { "description": "Specifies the status of the transaction.\n" @@ -77664,11 +78036,11 @@ "allOf": [ { "title": "ExternalPaymentTransactionStatus1Code", - "description": "Specifies the external payment transaction status code.", + "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\",\n \"SETT\": \"SETTLED\"\n}\n", "type": "string", "minLength": 1, "maxLength": 4, - "example": 1234 + "example": "SETT" }, { "description": "Specifies the status of the transaction.\n" @@ -84063,7 +84435,7 @@ "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": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" } ] }, @@ -84189,11 +84561,11 @@ "allOf": [ { "title": "ExternalPaymentTransactionStatus1Code", - "description": "Specifies the external payment transaction status code.", + "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\",\n \"SETT\": \"SETTLED\"\n}\n", "type": "string", "minLength": 1, "maxLength": 4, - "example": 1234 + "example": "SETT" }, { "description": "Specifies the status of the transaction.\n" @@ -93659,7 +94031,7 @@ "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": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" } ] }, @@ -93939,6 +94311,68 @@ } ] }, + "UndrlygCstmrCdtTrf": { + "allOf": [ + { + "title": "UnderlyingCustomerCreditTransfer", + "type": "object", + "properties": { + "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" + } + ] + } + } + }, + { + "description": "Underlying Customer Credit Transfer\nTBD\n" + } + ] + }, "IntrBkSttlmAmt": { "allOf": [ { @@ -103268,7 +103702,7 @@ "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": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" } ] }, @@ -103548,6 +103982,68 @@ } ] }, + "UndrlygCstmrCdtTrf": { + "allOf": [ + { + "title": "UnderlyingCustomerCreditTransfer", + "type": "object", + "properties": { + "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" + } + ] + } + } + }, + { + "description": "Underlying Customer Credit Transfer\nTBD\n" + } + ] + }, "IntrBkSttlmAmt": { "allOf": [ { @@ -112432,6 +112928,61 @@ "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, + "UnderlyingCustomerCreditTransfer": { + "title": "UnderlyingCustomerCreditTransfer", + "type": "object", + "properties": { + "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" + } + ] + } + } + }, "VerificationReason1Choice": { "title": "VerificationReason1Choice", "type": "object", diff --git a/src/fspiop/v2_0_ISO20022/openapi.ts b/src/fspiop/v2_0_ISO20022/openapi.ts index 27e75622..9d9cb6cc 100644 --- a/src/fspiop/v2_0_ISO20022/openapi.ts +++ b/src/fspiop/v2_0_ISO20022/openapi.ts @@ -1077,6 +1077,7 @@ export interface components { CreditTransferTransaction67: { PmtId: components["schemas"]["PaymentIdentification13"] & unknown; PmtTpInf?: components["schemas"]["PaymentTypeInformation28"] & unknown; + UndrlygCstmrCdtTrf?: components["schemas"]["UnderlyingCustomerCreditTransfer"] & unknown; IntrBkSttlmAmt: components["schemas"]["ActiveCurrencyAndAmount"] & unknown; InstdAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"] & unknown; XchgRate?: components["schemas"]["BaseOneRate"] & unknown; @@ -1155,6 +1156,7 @@ export interface components { CreditTransferTransaction68: { PmtId: components["schemas"]["PaymentIdentification13"] & unknown; PmtTpInf?: components["schemas"]["PaymentTypeInformation28"] & unknown; + UndrlygCstmrCdtTrf?: components["schemas"]["UnderlyingCustomerCreditTransfer"] & unknown; IntrBkSttlmAmt: components["schemas"]["ActiveCurrencyAndAmount"] & unknown; Dbtr: components["schemas"]["BranchAndFinancialInstitutionIdentification8"] & unknown; DbtrAcct?: components["schemas"]["CashAccount40"] & unknown; @@ -1412,7 +1414,17 @@ export interface components { /** * ExternalPaymentTransactionStatus1Code * @description Specifies the external payment transaction status code. - * @example 1234 + * + * For FSPIOP transfer state enumeration mappings: + * { + * "COMM": "COMMITED", + * "RESV": "RESERVED", + * "RECV": "RECEIVED", + * "ABOR": "ABORTED", + * "SETT": "SETTLED" + * } + * + * @example SETT */ ExternalPaymentTransactionStatus1Code: string; /** @@ -3746,6 +3758,10 @@ export interface components { * @example 8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e */ UUIDv4Identifier: string; + /** UnderlyingCustomerCreditTransfer */ + UnderlyingCustomerCreditTransfer: { + InstdAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"] & unknown; + }; /** * VerificationReason1Choice * @description Choice of format for the verification reason. diff --git a/src/fspiop/v2_0_ISO20022/schemas.ts b/src/fspiop/v2_0_ISO20022/schemas.ts index 3975b4dd..b817852f 100644 --- a/src/fspiop/v2_0_ISO20022/schemas.ts +++ b/src/fspiop/v2_0_ISO20022/schemas.ts @@ -163,6 +163,7 @@ export namespace Schemas { export const TermsRequest_FIToFICustomerCreditProposal = JsonSchemas.TermsRequest_FIToFICustomerCreditProposal export const TermsResponse_FIToFICustomerCreditConfirmation = JsonSchemas.TermsResponse_FIToFICustomerCreditConfirmation export const UUIDv4Identifier = JsonSchemas.UUIDv4Identifier + export const UnderlyingCustomerCreditTransfer = JsonSchemas.UnderlyingCustomerCreditTransfer export const VerificationReason1Choice = JsonSchemas.VerificationReason1Choice export const VerificationReport4 = JsonSchemas.VerificationReport4 export const hexBinary = JsonSchemas.hexBinary diff --git a/src/fspiop/v2_0_ISO20022/types.ts b/src/fspiop/v2_0_ISO20022/types.ts index 0520bef9..2f3e767f 100644 --- a/src/fspiop/v2_0_ISO20022/types.ts +++ b/src/fspiop/v2_0_ISO20022/types.ts @@ -163,6 +163,7 @@ export namespace Types { export type TermsRequest_FIToFICustomerCreditProposal = components['schemas']['TermsRequest_FIToFICustomerCreditProposal'] export type TermsResponse_FIToFICustomerCreditConfirmation = components['schemas']['TermsResponse_FIToFICustomerCreditConfirmation'] export type UUIDv4Identifier = components['schemas']['UUIDv4Identifier'] + export type UnderlyingCustomerCreditTransfer = components['schemas']['UnderlyingCustomerCreditTransfer'] export type VerificationReason1Choice = components['schemas']['VerificationReason1Choice'] export type VerificationReport4 = components['schemas']['VerificationReport4'] export type hexBinary = components['schemas']['hexBinary'] From 572a2e05bc53cf9402e02402722d1623481ef42a Mon Sep 17 00:00:00 2001 From: Kevin Leyow Date: Wed, 2 Oct 2024 05:59:12 -0500 Subject: [PATCH 05/10] chore: datetime --- .../v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml index 2eac7b39..67bd4d78 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml @@ -17,5 +17,5 @@ description: | Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed. type: string -format: datetime +format: date-time example: '2013-03-07T14:44:30.000Z' From 5edc6b154da6a74086f9f01b23b2b4e9afe2cef0 Mon Sep 17 00:00:00 2001 From: Kevin Leyow Date: Wed, 2 Oct 2024 06:20:17 -0500 Subject: [PATCH 06/10] chore: datetime --- ...-rest-v2.0-ISO20022-openapi3-snippets.yaml | 3 +- .../components/schemas/ISODateTime.yaml | 3 +- src/fspiop/v2_0_ISO20022/json-schemas.json | 54 +++++++++---------- src/fspiop/v2_0_ISO20022/openapi.ts | 1 - 4 files changed, 31 insertions(+), 30 deletions(-) diff --git a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml index a952d85f..9a785803 100644 --- a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +++ b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml @@ -4090,7 +4090,8 @@ components: involved parties shall agree on the maximum number of digits that are allowed. type: string - format: datetime + pattern: >- + ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$ example: "2013-03-07T14:44:30.000Z" ISOYear: title: ISOYear diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml index 67bd4d78..1a41843e 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml @@ -17,5 +17,6 @@ description: | Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed. type: string -format: date-time +pattern: >- + ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$ example: '2013-03-07T14:44:30.000Z' diff --git a/src/fspiop/v2_0_ISO20022/json-schemas.json b/src/fspiop/v2_0_ISO20022/json-schemas.json index 9fbe1f0e..88bd6e92 100644 --- a/src/fspiop/v2_0_ISO20022/json-schemas.json +++ b/src/fspiop/v2_0_ISO20022/json-schemas.json @@ -19896,7 +19896,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -20231,7 +20231,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -20245,7 +20245,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -31298,7 +31298,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -37317,7 +37317,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -43328,7 +43328,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -43342,7 +43342,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -49779,7 +49779,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -58915,7 +58915,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -68050,7 +68050,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -68710,7 +68710,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -68754,7 +68754,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -68768,7 +68768,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -69130,7 +69130,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, "ISOYear": { @@ -69166,7 +69166,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -76337,7 +76337,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -77618,7 +77618,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -77756,7 +77756,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -77929,7 +77929,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -79210,7 +79210,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -79348,7 +79348,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -85735,7 +85735,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -85873,7 +85873,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -93613,7 +93613,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -93627,7 +93627,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -103284,7 +103284,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { @@ -103298,7 +103298,7 @@ "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { diff --git a/src/fspiop/v2_0_ISO20022/openapi.ts b/src/fspiop/v2_0_ISO20022/openapi.ts index 9d9cb6cc..b95f32c3 100644 --- a/src/fspiop/v2_0_ISO20022/openapi.ts +++ b/src/fspiop/v2_0_ISO20022/openapi.ts @@ -2267,7 +2267,6 @@ export interface components { ISODate: string; /** * ISODateTime - * Format: datetime * @description A particular point in the progression of time defined by a mandatory * date and a mandatory time component, expressed in either UTC time * format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format From da073e6de4e0984f31a788333bc6b01dcb068940 Mon Sep 17 00:00:00 2001 From: Kevin Leyow Date: Wed, 2 Oct 2024 10:23:48 -0500 Subject: [PATCH 07/10] chore: changes --- ...-rest-v2.0-ISO20022-openapi3-snippets.yaml | 22 + .../UnderlyingCustomerCreditTransfer.yaml | 21 + src/fspiop/v2_0_ISO20022/json-schemas.json | 171832 +++++++++------ src/fspiop/v2_0_ISO20022/openapi.ts | 4 + 4 files changed, 103945 insertions(+), 67934 deletions(-) diff --git a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml index 9a785803..da61d9da 100644 --- a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +++ b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml @@ -6559,6 +6559,28 @@ components: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. + Dbtr: + allOf: + - $ref: "#/components/schemas/PartyIdentification272" + - description: | + Party that owes an amount of money to the (ultimate) creditor. + Cdtr: + allOf: + - $ref: "#/components/schemas/PartyIdentification272" + - description: | + Party to which an amount of money is due. + DbtrAgt: + allOf: + - $ref: >- + #/components/schemas/BranchAndFinancialInstitutionIdentification8 + - description: | + Financial institution servicing an account for the debtor. + CdtrAgt: + allOf: + - $ref: >- + #/components/schemas/BranchAndFinancialInstitutionIdentification8 + - description: | + Financial institution servicing an account for the creditor. VerificationReason1Choice: title: VerificationReason1Choice type: object diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/UnderlyingCustomerCreditTransfer.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/UnderlyingCustomerCreditTransfer.yaml index eab4fb74..204551c2 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/UnderlyingCustomerCreditTransfer.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/UnderlyingCustomerCreditTransfer.yaml @@ -9,3 +9,24 @@ properties: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. + Dbtr: + allOf: + - $ref: ./PartyIdentification272.yaml + - description: > + Party that owes an amount of money to the (ultimate) creditor. + Cdtr: + allOf: + - $ref: ./PartyIdentification272.yaml + - description: > + Party to which an amount of money is due. + DbtrAgt: + allOf: + - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml + - description: > + Financial institution servicing an account for the debtor. + CdtrAgt: + allOf: + - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml + - description: > + Financial institution servicing an account for the creditor. + diff --git a/src/fspiop/v2_0_ISO20022/json-schemas.json b/src/fspiop/v2_0_ISO20022/json-schemas.json index 88bd6e92..b76de07c 100644 --- a/src/fspiop/v2_0_ISO20022/json-schemas.json +++ b/src/fspiop/v2_0_ISO20022/json-schemas.json @@ -5743,663 +5743,435 @@ "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": "Underlying Customer Credit Transfer\nTBD\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": { + "Dbtr": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\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": { + "Nm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "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})$" + "minLength": 1, + "maxLength": 140, + "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": "Name\nName by which a party is known and which is usually used to identify that 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": { + "PstlAdr": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "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", - "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" - ] - } + "description": "AddressType2Code\nSpecifies 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", - "anyOf": [ + "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" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "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" + } }, - "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 + "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" + } + ] }, - { - "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": [ + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 256, + "example": 256 }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Identification\nIdentification 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", @@ -6410,102 +6182,425 @@ "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": { + ] + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { "Cd": "BIC" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" + }, + "Issr": "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" - } - ] + { + "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": [ + "OrgId" ] - } - }, - "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 + { + "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" + } + ] + } }, - "Issr": 123 + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, - "BrnchId": { + "CtryOfRes": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\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 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": { - "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", @@ -6516,885 +6611,714 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, - "LEI": { + "JobTitl": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated 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": "JobTitle\nTitle of the function.\n" } ] }, - "Nm": { + "Rspnsblty": { "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": "Responsibility\nRole of a person in an organisation.\n" } ] }, - "PstlAdr": { + "Dept": { "allOf": [ { - "title": "PostalAddress27", + "title": "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 address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ + "ChanlTp": { + "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": "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": "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": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\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": "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": { - "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" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\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" } ] } }, "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "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": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ - "FinInstnId" + "Id" ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" }, - "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": { + "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": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" + "description": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, - "Tp": { + "Cdtr": { "allOf": [ { - "title": "ChargeType3Choice", - "description": "ChargeType3Choice\nSpecifies the type of charge.\n", + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification3", + "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": "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" + "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" ] }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "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" - } - ] - } - }, - "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": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\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": [ - "Cd" - ] + "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" + } }, { - "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": "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" + } + ] }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "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" + } + ] }, - { - "description": "Issuer\nEntity that assigns the identification.\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" + } + ] } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the 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": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + ] } + }, + "required": [ + "OrgId" ] - } - }, - "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": { + "PrvtId": { "allOf": [ { - "title": "GenericOrganisationIdentification3", + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", "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": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", "type": "object", "properties": { - "Cd": { + "BirthDt": { "allOf": [ { - "title": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification 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", + "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": 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": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, - "Prtry": { + "CityOfBirth": { "allOf": [ { "title": "Max35Text", @@ -7405,1452 +7329,1091 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "CityOfBirth\nCity where a person was born.\n" } ] - } - }, - "anyOf": [ - { - "properties": { - "Cd": {} - } }, - { - "properties": { - "Prtry": {} - } + "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": { - "Cd": "BIC" + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" } }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, - "Issr": { + "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": "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": "Issuer\nEntity that assigns the identification.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Id" - ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - "Issr": "BIC" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } } }, { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, - "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } - } + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" }, - { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } - ] + } + }, + { + "description": "Identification\nUnique and unambiguous identification of a party.\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": "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": { + "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": "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" - } - ] + "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", - "anyOf": [ + { + "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" - } - }, - { - "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" - ] + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] - } + "Id": { + "OrgId": { + "AnyBIC": "BIC" }, - "required": [ - "Prtry" - ] + "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" } - ], - "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" + "description": "Party to which an amount of money is due.\n" } ] }, - "Prxy": { + "DbtrAgt": { "allOf": [ { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "Tp": { + "FinInstnId": { "allOf": [ { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", + "title": "FinancialInstitutionIdentification23", "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" - } - ] + "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": "Max35Text", - "description": "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": { + "ClrSysMmbId": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", - "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "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\nClearing system identification code, 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\nProprietary identification of the clearing system.\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": "CHIPS" + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "MmbId": { + "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": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "LEI\nLegal entity identifier of the financial 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", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ + "Nm": { + "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": "Max140Text", + "description": "Specifies 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" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "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" + ], + "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" + } + ] }, - "AdrLine": { - "title": "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": { + "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": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "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 or a branch of a financial institution.\n" } ] }, - "Othr": { + "BrnchId": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\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": [ @@ -8863,945 +8426,945 @@ "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", - "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" - } + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-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": "LEI\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", - "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" - ] - }, + "PstlAdr": { + "allOf": [ { + "title": "PostalAddress27", + "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" + } + }, + "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" + } + }, + { + "description": "PostalAddress\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 + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Financial institution servicing an account for the debtor.\n" + } + ] + }, + "CdtrAgt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "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" + } + ] }, - "BldgNb": { - "title": "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": { + "ClrSysMmbId": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", - "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "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\nClearing system identification code, 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\nProprietary identification of the clearing system.\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": "CHIPS" + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "MmbId": { + "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": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "LEI\nLegal entity identifier of the financial 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", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ + "Nm": { + "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": "Max140Text", + "description": "Specifies 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": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } + "Cd" + ] }, { - "description": "Proprietary\nType of address expressed as a proprietary 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": "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": [ - "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 or a branch of a financial institution.\n" } ] }, - "Othr": { + "BrnchId": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\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": [ @@ -9814,621 +9377,650 @@ "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", - "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" - } + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-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": "LEI\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", - "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" - ] - }, + "PstlAdr": { + "allOf": [ { + "title": "PostalAddress27", + "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" + } + }, + "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": { - "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": { - "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, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\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": "Financial institution servicing an account for the creditor.\n" + } + ] + } + } + }, + { + "description": "Underlying Customer Credit Transfer\nTBD\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": [ - "FinInstnId" + "ActiveCurrencyAndAmount", + "Ccy" ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "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" + } + ] }, - "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" - } + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under 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": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" + "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" } ] }, - "Cdtr": { + "XchgRate": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "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": { - "Nm": { + "Amt": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "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": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" } ] }, - "PstlAdr": { + "Agt": { "allOf": [ { - "title": "PostalAddress27", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ + "FinInstnId": { + "allOf": [ { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "Cd": { + "BICFI": { "allOf": [ { - "description": "AddressType2Code\nSpecifies 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": "BICFIDec2014Identifier", "type": "string", - "example": "ADDR" + "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\nType of address expressed as a code.\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": "GenericIdentification30", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { + "ClrSysId": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -10439,524 +10031,583 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "Id", - "Issr" + "MmbId" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\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" }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": "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 }, - "Othr": { - "allOf": [ - { - "title": "GenericOrganisationIdentification3", + { + "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": "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": "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": "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 + { + "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": "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 + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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\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" + } + ] } - ] - } - }, - "anyOf": [ - { - "properties": { - "Cd": {} + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "properties": { - "Prtry": {} - } + "description": "Proprietary\nType of address expressed as a proprietary code.\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": "BIC" - }, - "Issr": "BIC" + "Cd": "ADDR" } }, - { - "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" - } - ] + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "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 }, - "CityOfBirth": { - "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": "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": "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": "CityOfBirth\nCity 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" + ] } - ] + ], + "example": { + "Cd": "BIC" + } }, - "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" - } - ] + { + "description": "SchemeName\nName of the identification scheme.\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" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "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" + } }, - "Othr": { - "allOf": [ - { - "title": "GenericPersonIdentification2", + { + "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": "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" + "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": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "type": "object", - "anyOf": [ + { + "properties": { + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalPersonIdentification1Code", - "description": "Specifies the external person 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" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -10967,1031 +10618,1245 @@ "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" - ] - } - ], - "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" + "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, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" + "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalChargeType1Code", + "description": "Specifies the type of charge applied to the transaction.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nCharge type, in a coded form.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification3", + "type": "object", + "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": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "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": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } + "Id": 123, + "Issr": "BIC" } }, { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n" } ] } }, "required": [ - "PrvtId" + "Prtry" ] } ], "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } + "Cd": "CASH" } }, { - "description": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "Type\nDefines the type of charges.\n" } ] + } + }, + "required": [ + "Amt", + "Agt" + ], + "example": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" }, - "CtryOfRes": { + "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": "CountryCode", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 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": 140, + "example": 12345 }, { - "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": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, - "CtctDtls": { + "PstlAdr": { "allOf": [ { - "title": "Contact13", - "description": "Specifies the details of the contact person.\n", + "title": "PostalAddress27", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\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": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\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": "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": { + "Prtry": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 128, - "example": 12345 + "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": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ - "ChanlTp" - ], - "example": { - "ChanlTp": "PHON", - "Id": 1234567890 - } - }, - { - "description": "OtherContact\nContact details in another form.\n" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "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" - } - ] + "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": { - "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" + "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": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\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", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", "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": { + "OrgId": { "allOf": [ { - "title": "GenericAccountIdentification1", + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { - "Id": { + "AnyBIC": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "title": "AnyBICDec2014Identifier", "type": "string", - "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 + "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\nIdentification assigned by an institution.\n" + "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, - "SchmeNm": { + "LEI": { "allOf": [ { - "title": "AccountSchemeName1Choice", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": "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": "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": [ { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "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": [ - "Prtry" ] } + }, + "required": [ + "Id" ], "example": { - "Cd": 1111 + "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": "IBAN" - }, - "Issr": "BIC" + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "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" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ - "Cd" + "OrgId" ] }, { "properties": { - "Prtry": { + "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": "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": "Proprietary\nNature or use of the account in a proprietary form.\n" + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ - "Prtry" + "PrvtId" ] } ], "example": { - "Cd": "CACC" + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } } }, { - "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": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, - "Nm": { + "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": "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": "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" } ] }, - "Prxy": { + "CtctDtls": { "allOf": [ { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", "type": "object", "properties": { - "Tp": { + "NmPrfx": { "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" - ] - } + "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": "EMAIL" - } + "type": "string", + "example": "DOCT" }, { - "description": "Type\nType of the proxy identification.\n" + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, - "Id": { + "Nm": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 2048, - "example": 2048 + "maxLength": 140, + "example": 12345 }, { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that 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 - }, - { - "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 + "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" + } + ] }, - { - "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 + "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" + } + ] }, - { - "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": { + "FaxNb": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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": 140, - "example": 12345 + "maxLength": 2048, + "example": 2048 }, { - "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n" + "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, - "Ctry": { + "EmailAdr": { "allOf": [ { - "title": "CountryCode", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 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": 256, + "example": 256 }, { - "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n" + "description": "EmailAddress\nAddress for electronic mail (e-mail).\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": { + }, + "EmailPurp": { "allOf": [ { "title": "Max35Text", @@ -12002,793 +11867,704 @@ "example": 1.234567890123457e+34 }, { - "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" + "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, - "Dt": { + "JobTitl": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. 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 related to the specified type of regulatory reporting details.\n" + "description": "JobTitle\nTitle of the function.\n" } ] }, - "Ctry": { + "Rspnsblty": { "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": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" + "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, - "Cd": { + "Dept": { "allOf": [ { - "title": "Max10Text", - "description": "Specifies a character string with a maximum length of 10 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 10, - "example": 1234567890 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, { - "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": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, - "Amt": { + "Othr": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\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": { + "ChanlTp": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", "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})$" + "minLength": 1, + "maxLength": 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": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "Ccy": { + "Id": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 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": 128, + "example": 12345 }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "ChanlTp" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" + "description": "OtherContact\nContact details in another form.\n" } ] }, - "Inf": { - "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", - "anyOf": [ + "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" }, { - "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": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { - "Tp": "T1", - "Dt": "2018-01-01", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 - }, - "Inf": 12345 + "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" } }, { - "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" - } - ] - } - }, - "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": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "DbtCdtRptgInd": "CRED", - "Authrty": { - "Nm": "Swiss National Bank", - "Ctry": "CH" + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" }, - "Dtls": { - "Cd": "A1", - "Inf": "Mandatory regulatory information" + "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": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" + "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" } ] }, - "Tax": { + "DbtrAcct": { "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": "CashAccount40", "type": "object", + "description": "Provides the details to identify an account.\n", "properties": { - "Cdtr": { + "Id": { "allOf": [ { - "title": "TaxParty1", - "description": "Details about the entity involved in the tax paid or to be paid.\n", + "title": "AccountIdentification4Choice", "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" + "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" ] }, - "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" + { + "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": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT" + "IBAN": "BE71096123456769" } }, { - "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" + "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, - "Dbtr": { + "Tp": { "allOf": [ { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\n", + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\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" + "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" ] }, - "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" - } - ] + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "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\n\nName of the debtor or the debtor's authorised representative.\n" - } - ] + { + "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } - }, - "example": { - "Titl": "Mr", - "Nm": "John Doe" - } - }, - { - "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" + ] } + }, + "required": [ + "Prtry" ] } - }, + ], "example": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT", - "Authstn": { - "Titl": "Mr", - "Nm": "John Doe" - } + "Cd": "CACC" } }, { - "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" + "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, - "UltmtDbtr": { + "Ccy": { "allOf": [ { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\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": 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": { - "TaxId": { + "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 + "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": "TaxIdentification\n\nTax identification number of the debtor.\n" + "description": "Type\nType of the proxy identification.\n" } ] }, - "RegnId": { + "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": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" }, - "TaxTp": { + "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": "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": "TaxType\n\nType of tax payer.\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" } ] }, - "Authstn": { + "ClrSysMmbId": { "allOf": [ { - "title": "TaxAuthorisation1", - "description": "Details of an authorised tax paying party.\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": { - "Titl": { + "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": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "Nm": { + "MmbId": { "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\n\nName of the debtor or the debtor's authorised representative.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, + "required": [ + "MmbId" + ], "example": { - "Titl": "Mr", - "Nm": "John Doe" + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "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" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within 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" - }, - { - "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": { + "LEI": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "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})$" + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Amount of 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": "LEI\nLegal entity identifier of the financial institution.\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": { + "Nm": { "allOf": [ { "title": "Max140Text", @@ -12799,2456 +12575,2894 @@ "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" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, - "Prd": { + "PstlAdr": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "PostalAddress24", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "FrToDt": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", "properties": { - "FrDt": { + "Cd": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\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", - "format": "date", - "example": "2013-03-07" + "example": "ADDR" }, { - "description": "FromDate\nStart date of the range.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "ToDt": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" + "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": "ToDate\nEnd date of the range.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "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" - } - ] + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - "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" - } - ] + "SubDept": { + "title": "Max70Text", + "description": "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": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "TaxAmt": { + "Othr": { "allOf": [ { - "title": "TaxAmount3", - "description": "Information on the amount of the tax record.\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": { - "Rate": { + "Id": { "allOf": [ { - "title": "PercentageRate", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "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})$" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Rate\n\nRate used to calculate the tax.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "TaxblBaseAmt": { + "SchmeNm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "FinancialIdentificationSchemeName1Choice", "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" + "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": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under 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": "BIC" } }, { - "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "TtlAmt": { + "Issr": { "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - "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" - } - } + "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "Amt": { + } + }, + "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", - "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})$" + "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\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" - } - } - }, - { - "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" + "Prtry" + ] } - ] - } - }, - "example": { - "Rate": 0, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 0 + ], + "example": { + "Cd": "ADDR" + } }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 0 + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, - "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" + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "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": { - "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" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "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" - } - ] + "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", + "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" + } + ] + } }, - "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": [ + "Cd" + ] }, - "required": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "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": { + "Cd": "CHIPS" } - ] - } + }, + { + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + } + ] }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } - ] - }, - "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": "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" + } + ] } }, - { - "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" - } - ] - } + "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" + } + ] }, - "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" - } - ] - } + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum 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": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } - ] - } - }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\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": { - "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" - } - } + "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, - "Amt": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\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" + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" } - ] - } + }, + { + "description": "SchemeName\nName of the identification scheme.\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 + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "Inf": 12345 - } + { + "description": "Issuer\nEntity that assigns the identification.\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" + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } - ] - } - }, - "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 + { + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } - }, - "AddtlInf": "VAT applicable" + ] } }, - "type": "array" + "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" } ] - } - }, - "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": { + "BrnchId": { "allOf": [ { - "title": "hexBinary", - "type": "string", - "example": 4660, - "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" + "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "IlpV4PrepPacket" - ] + "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": { - "Sh256Sgntr": { + "Nm": { "allOf": [ { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", - "example": "1234567890ABCDEF1234567890ABCDEF" + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "description": "SHA-256 signature of the terms\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] - } - }, - "required": [ - "Sh256Sgntr" - ] - } - ], - "example": { - "IlpV4PrepPacket": "1234567890ABCDEF" - } - } - }, - "required": [ - "PmtId", - "IntrBkSttlmAmt", - "ChrgBr", - "Dbtr", - "DbtrAgt", - "CdtrAgt", - "Cdtr" - ], - "example": { - "PmtId": { - "InstrId": "INSTRID", - "EndToEndId": "ENDTOENDID" - }, - "PmtTpInf": { - "LclInstrm": { - "Cd": "CHQB", - "Prtry": "PROPRIETARY" - }, - "SeqTp": "SEQTP" - }, - "IntrBkSttlmAmt": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" - }, - "InstdAmt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - }, - "XchgRate": 123.45, - "ChrgBr": "SHAR", - "ChrgsInf": { - "Amt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - }, - "Agt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "Tp": { - "Cd": "SHAR" - } - }, - "Dbtr": { - "Nm": "NAME", - "PstlAdr": { - "AdrTp": "ADDR", - "BldgNb": "BLDGNB", - "Ctry": "CTRY", - "TwnNm": "TWNNM", - "PstCd": "PSTCD", - "StrtNm": "STRTNM" - } - }, - "DbtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "DbtrAgt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "CdtrAgt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "Cdtr": { - "Nm": "NAME", - "PstlAdr": { - "AdrTp": "ADDR", - "BldgNb": "BLDGNB", - "Ctry": "CTRY", - "TwnNm": "TWNNM", - "PstCd": "PSTCD", - "StrtNm": "STRTNM" - } - }, - "CdtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "InstrForCdtrAgt": { - "Cd": "CODE" - }, - "InstrForNxtAgt": { - "Cd": "CODE" - }, - "Purp": { - "Cd": "CASH" - }, - "RgltryRptg": { - "Dbtr": true, - "Cdtr": true - }, - "Tax": "Cdtr" - } - }, - "CreditTransferTransaction68": { - "title": "CreditTransferTransaction68", - "description": "Provides further details specific to the individual transaction(s) included in the message.\n", - "type": "object", - "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 in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" - } - ] - }, - "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": { + "PstlAdr": { "allOf": [ { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", + "title": "PostalAddress27", "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" + "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" ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" + }, + { + "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": [ - "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": { - "Cd": "SEPA" + "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": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "LclInstrm": { + "Id": { "allOf": [ { - "title": "LocalInstrument2Choice", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", "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": { + "OrgId": { "allOf": [ { - "title": "Max35Text", - "description": "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 + "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": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ - "Cd" + "OrgId" ] }, { "properties": { - "Prtry": { + "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": "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": "Proprietary\nCategory purpose, in a proprietary form.\n" + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ - "Prtry" + "PrvtId" ] } ], "example": { - "Cd": "CASH" + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } } }, { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] - } - }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" }, - "LclInstrm": { - "Cd": "CORE" + "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" + } + ] }, - "CtgyPurp": { - "Cd": "CASH" - } - } - }, - { - "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" - } - ] - }, - "UndrlygCstmrCdtTrf": { - "allOf": [ - { - "title": "UnderlyingCustomerCreditTransfer", - "type": "object", - "properties": { - "InstdAmt": { + "CtctDtls": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "Contact13", + "description": "Specifies the details of the contact person.\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": { + "NmPrfx": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "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": 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})$" + "example": "DOCT" }, { - "description": "Amount of 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": "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.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\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" - } - ] - } - } - }, - { - "description": "Underlying Customer Credit Transfer\nTBD\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": { + }, + "PhneNb": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "title": "PhoneNumber", "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": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { - "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": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, - "ClrSysMmbId": { + "MobNb": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "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": { - "ClrSysId": { + "ChanlTp": { "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" - } + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "MmbId": { + "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": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "MmbId" + "ChanlTp" ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "description": "OtherContact\nContact details in another form.\n" } ] }, - "LEI": { + "PrefrdMtd": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated 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": "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", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" }, { - "description": "LEI\nLegal entity identifier of the financial institution.\n" + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies 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" + } + }, + "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" ] }, - "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", + { + "properties": { + "Othr": { + "allOf": [ + { + "title": "GenericAccountIdentification1", "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "SchmeNm": { + "allOf": [ + { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "anyOf": [ { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { + "Cd": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "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", - "pattern": "^[a-zA-Z0-9]{4}$", + "minLength": 1, + "maxLength": 4, "example": 1234 }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\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", @@ -15259,148 +15473,106 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum 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": "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": 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": { - "Cd": "ADDR" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "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", + { + "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": 35, - "example": 1.234567890123457e+34 + "maxLength": 4, + "example": 1234 }, - "CtrySubDvsn": { + { + "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", @@ -15408,206 +15580,414 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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\nNature or use of the account 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" ] - }, - "Othr": { + } + ], + "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": "GenericFinancialIdentification1", + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy 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", - "anyOf": [ + "anyOf": [ + { + "properties": { + "Cd": { + "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": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type 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\nProxy account type, in a coded form as published in an external list.\n" } - ], - "example": { - "Cd": "BIC" - } - }, - { - "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\nProxy account type, in a proprietary form.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Id" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "Cd": "EMAIL" } }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\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": [], + "required": [ + "Id" + ], "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" + "Tp": { + "Cd": "IBAN" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 - } + "Id": 123 } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" }, - "BrnchId": { + "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": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "type": "object", + "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": { - "Id": { + "Nm": { + "allOf": [ + { + "title": "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", @@ -15618,1323 +15998,808 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" } ] }, - "LEI": { + "Dt": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated 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": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation 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-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "format": "date", + "example": "2013-03-07" }, { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" + "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" } ] }, - "Nm": { + "Ctry": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 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": 140, - "example": 12345 + "maxLength": 10, + "example": 1234567890 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\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" } ] }, - "PstlAdr": { + "Amt": { "allOf": [ { - "title": "PostalAddress27", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "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": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ + "ActiveOrHistoricCurrencyAndAmount": { + "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": "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": "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": "Amount of 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": "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 + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under 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": { - "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" + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\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", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "type": "array" } ] } }, "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "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" + } + ] + } + }, + "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" } ] } }, - "required": [ - "FinInstnId" - ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" }, - "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" - } + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" } } }, { - "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" + "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" } ] }, - "DbtrAcct": { + "Tax": { "allOf": [ { - "title": "CashAccount40", + "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", - "description": "Provides the details to identify an account.\n", "properties": { - "Id": { + "Cdtr": { "allOf": [ { - "title": "AccountIdentification4Choice", + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\n", "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" - } - ] + "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" } - }, - "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" - } - ] + "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" } - }, - "required": [ - "Othr" ] } - ], + }, "example": { - "IBAN": "BE71096123456769" + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT" } }, { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" + "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" } ] }, - "Tp": { + "Dbtr": { "allOf": [ { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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" + } + ] }, - { - "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\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" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "CACC" + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } } }, { - "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": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" } ] }, - "Prxy": { + "UltmtDbtr": { "allOf": [ { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "properties": { - "Tp": { + "TaxId": { "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" - } + "title": "Max35Text", + "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\nType of the proxy identification.\n" + "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, - "Id": { + "RegnId": { "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": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a 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": "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": { + "TaxTp": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "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": 35, + "example": 1.234567890123457e+34 }, { - "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": "TaxType\n\nType of tax payer.\n" } ] }, - "ClrSysMmbId": { + "Authstn": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", "type": "object", "properties": { - "ClrSysId": { + "Titl": { "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" - } + "title": "Max35Text", + "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": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, - "MmbId": { + "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": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, - "required": [ - "MmbId" - ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Titl": "Mr", + "Nm": "John Doe" } }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" } ] - }, - "LEI": { + } + }, + "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": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated 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": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "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": "LEI\nLegal entity identifier of the financial institution.\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" } ] }, - "Nm": { + "Ccy": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "ActiveOrHistoricCurrencyCode", "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "description": "A code allocated to a currency by a Maintenance Agency under 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": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + "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" } ] }, - "PstlAdr": { + "Ccy": { "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" - } + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under 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": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, - "required": [], + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], "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 - } + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" } ] }, - "BrnchId": { + "Dt": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\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": "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": { - "Id": { + "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", @@ -16945,2459 +16810,1994 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" } ] }, - "LEI": { + "Ctgy": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated 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": "Category\n\nSpecifies the tax code as published by the tax authority.\n" } ] }, - "Nm": { + "CtgyDtls": { "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": "CategoryDetails\n\nProvides further details of the category tax code.\n" } ] }, - "PstlAdr": { + "DbtrSts": { "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": "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", - "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": [ + "FrToDt": { + "allOf": [ { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", "properties": { - "Cd": { + "FrDt": { "allOf": [ { - "description": "AddressType2Code\nSpecifies 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": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", - "example": "ADDR" + "format": "date", + "example": "2013-03-07" }, { - "description": "Code\nType of address expressed as a code.\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": [ - "Cd" - ] + "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": { - "Prtry": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "GenericIdentification30", + "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", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { + "FrToDt": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "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": "^[a-zA-Z0-9]{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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "Issr": { + "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": "Issuer\nEntity that assigns the identification.\n" + "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" } ] }, - "SchmeNm": { + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ - "Id", - "Issr" + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Amount\n\nUnderlying tax amount related to the specified period.\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": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, { - "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 + "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": "Code\nClearing system identification code, as published in an external list.\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" + } + ] }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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" + } + ] + } }, - { - "description": "Proprietary\nProprietary identification of the clearing system.\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" } }, - "required": [ - "Prtry" - ] + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } } - ], - "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" + }, + "type": "array" } ] } }, - "required": [ - "MmbId" - ], "example": { - "ClrSysId": { - "Cd": "CHQB" + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 }, - "MmbId": 123456789 + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } } }, { - "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" + "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } ] }, - "Nm": { + "Tp": { "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": "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" + } }, - "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" - } - ] - } + "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" }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + { + "description": "FromDate\nStart date of the range.\n" } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\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" } }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "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", + "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" + } + ] } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "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": { + "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\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 - }, - { - "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 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" - } - ] + "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" } }, - "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": "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" + } + ] + } + }, + "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" + } + ] + } }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": { + "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" + } + ] + } }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length 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" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, - "required": [ - "Id", - "Issr" - ], - "example": { - "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": [ - "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": [ - { + ] + } + }, + "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": { - "Cd": { + "Prd": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", - "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "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": "Code\nClearing system identification code, 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" - ] - }, - { - "properties": { - "Prtry": { + }, + "Amt": { "allOf": [ { - "title": "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": "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": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "CHIPS" + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + "type": "array" } - }, - { - "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" - ] + "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 }, - { - "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" + "Inf": 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": "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": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\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 - }, - { - "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" - } - ] - } + ] + }, + "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 }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + { + "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 }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "TtlAmt": { + "Ccy": "EUR", + "Amt": 200 } - ] - } - }, - "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 + "AddtlInf": "VAT applicable" } - } - }, - { - "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "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" + }, + "type": "array" } ] } }, - "required": [ - "FinInstnId" - ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "Cdtr": { + "Titl": "Mr", + "Nm": "John Doe" }, - "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" - } + "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": "Creditor\nParty to which an amount of money is due.\n" + "description": "Tax\nProvides details on the tax.\n" } ] }, - "CdtrAcct": { - "allOf": [ + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "Cryptographically signed terms\n", + "type": "object", + "anyOf": [ { - "title": "CashAccount40", - "type": "object", - "description": "Provides the details to identify an account.\n", "properties": { - "Id": { + "IlpV4PrepPacket": { "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" - } + "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": [ + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + }, + "SeqTp": "SEQTP" + }, + "IntrBkSttlmAmt": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "InstdAmt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "XchgRate": 123.45, + "ChrgBr": "SHAR", + "ChrgsInf": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + }, + "Dbtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "CODE" + }, + "InstrForNxtAgt": { + "Cd": "CODE" + }, + "Purp": { + "Cd": "CASH" + }, + "RgltryRptg": { + "Dbtr": true, + "Cdtr": true + }, + "Tax": "Cdtr" + } + }, + "CreditTransferTransaction68": { + "title": "CreditTransferTransaction68", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "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 in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" + } + ] + }, + "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": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\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": [ - "Othr" + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": { - "IBAN": "BE71096123456769" + "Cd": "SEPA" } }, { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" + "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, - "Tp": { + "LclInstrm": { "allOf": [ { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", + "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": "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": "ExternalLocalInstrument1Code", + "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 35, + "example": 12345 }, { - "description": "Code\nAccount type, in a coded form.\n" + "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } @@ -19419,7 +18819,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } @@ -19430,1031 +18830,1249 @@ } ], "example": { - "Cd": "CACC" + "Cd": "CH03" } }, { - "description": "Type\nSpecifies the nature, or use of the account.\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" } ] }, - "Ccy": { + "CtgyPurp": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under 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" + "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": "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": "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" }, - "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" - } - ] + "LclInstrm": { + "Cd": "CORE" }, - "Prxy": { + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + { + "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" + } + ] + }, + "UndrlygCstmrCdtTrf": { + "allOf": [ + { + "title": "UnderlyingCustomerCreditTransfer", + "type": "object", + "properties": { + "InstdAmt": { "allOf": [ { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\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": { - "Tp": { + "ActiveOrHistoricCurrencyAndAmount": { "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" - } + "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": "Type\nType of the proxy identification.\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": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "title": "ActiveOrHistoricCurrencyCode", "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 + "description": "A code allocated to a currency by a Maintenance Agency under 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": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ - "Id" + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" ], "example": { - "Tp": { - "Cd": "IBAN" - }, - "Id": 123 + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "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": "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" } ] }, - "InstrInf": { + "Dbtr": { "allOf": [ { - "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 + "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" + } + ] }, - { - "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}$" + "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" + } + ] }, - { - "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" + "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" + } + }, + { + "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": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + { + "description": "Identification\nUnique and unambiguous identification of a party.\n" + } + ] }, - { - "description": "SHA-256 signature of the terms\n" - } - ] - } - }, - "required": [ - "Sh256Sgntr" - ] - } - ], - "example": { - "IlpV4PrepPacket": "1234567890ABCDEF" - } - }, - { - "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" - } - ] - } - }, - "required": [ - "PmtId", - "IntrBkSttlmAmt", - "Dbtr", - "Cdtr" - ], - "example": { - "PmtId": { - "InstrId": "INSTRID", - "EndToEndId": "ENDTOENDID" - }, - "PmtTpInf": { - "LclInstrm": { - "Cd": "CHQB", - "Prtry": "PROPRIETARY" - } - }, - "IntrBkSttlmAmt": { - "Amount": 123.45, - "Ccy": "EUR" - }, - "Dbtr": { - "Nm": "Debtor Name" - }, - "DbtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "DbtrAgt": { - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "CdtrAgt": { - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "Cdtr": { - "Nm": "Creditor Name" - }, - "CdtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "InstrForCdtrAgt": { - "Cd": "INSTRUCTION" - }, - "Purp": { - "Cd": "CHAR" - }, - "VrfctnOfTerms": { - "Cntt": "CONTENT", - "CnttTp": "PROPRIETARY" - } - } - }, - "CryptographicLockChoice": { - "title": "CryptographicLockChoice", - "description": "Cryptographically signed terms\n", - "type": "object", - "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" - } - }, - "DateAndDateTime2Choice": { - "title": "StatusReason6Choice", - "description": "Specifies the reason for the status.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "Dt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "Date\nSpecified date.\n" - } - ] - } - }, - "required": [ - "Dt" - ] - }, - { - "properties": { - "DtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "DateTime\nSpecified date and time.\n" - } - ] - } - }, - "required": [ - "DtTm" - ] - } - ], - "example": { - "DtTm": "2020-01-01T00:00:00Z" - } - }, - "DateAndPlaceOfBirth1": { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "properties": { - "BirthDt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "BirthDate\nDate on which a person was born.\n" - } - ] - }, - "PrvcOfBirth": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "ProvinceOfBirth\nProvince where a person was born.\n" - } - ] - }, - "CityOfBirth": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "CityOfBirth\nCity where a person was born.\n" - } - ] - }, - "CtryOfBirth": { - "allOf": [ - { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - { - "description": "CountryOfBirth\nCountry where a person was born.\n" - } - ] - } - }, - "required": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" - ], - "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" - } - }, - "DatePeriod2": { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "properties": { - "FrDt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "FromDate\nStart date of the range.\n" - } - ] - }, - "ToDt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "ToDate\nEnd date of the range.\n" - } - ] - } - }, - "required": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" - } - }, - "ErrorCode": { - "title": "ErrorCode", - "type": "string", - "pattern": "^[1-9]\\d{3}$", - "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.", - "example": "5100" - }, - "ErrorDescription": { - "title": "ErrorDescription", - "type": "string", - "minLength": 1, - "maxLength": 128, - "description": "Error description string." - }, - "ErrorInformation": { - "title": "ErrorInformation", - "type": "object", - "description": "Data model for the complex type ErrorInformation.", - "properties": { - "errorCode": { - "title": "ErrorCode", - "type": "string", - "pattern": "^[1-9]\\d{3}$", - "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.", - "example": "5100" - }, - "errorDescription": { - "title": "ErrorDescription", - "type": "string", - "minLength": 1, - "maxLength": 128, - "description": "Error description string." - }, - "extensionList": { - "title": "ExtensionList", - "type": "object", - "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" - ] - } - }, - "required": [ - "errorCode", - "errorDescription" - ] - }, - "ErrorInformationResponse": { - "title": "ErrorInformationResponse", - "type": "object", - "description": "Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.\n", - "properties": { - "errorInformation": { - "title": "ErrorInformation", - "type": "object", - "description": "Data model for the complex type ErrorInformation.", - "properties": { - "errorCode": { - "title": "ErrorCode", - "type": "string", - "pattern": "^[1-9]\\d{3}$", - "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.", - "example": "5100" - }, - "errorDescription": { - "title": "ErrorDescription", - "type": "string", - "minLength": 1, - "maxLength": 128, - "description": "Error description string." - }, - "extensionList": { - "title": "ExtensionList", - "type": "object", - "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" - ] - } - }, - "required": [ - "errorCode", - "errorDescription" - ] - } - } - }, - "Exact32HexBinaryText": { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", - "type": "string", - "example": "1234567890ABCDEF1234567890ABCDEF" - }, - "Exact4AlphaNumericText": { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - "Execute_FIToFICustomerCreditTransferV13": { - "title": "Execute_FIToFICustomerCreditTransferV13", - "type": "object", - "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", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "Creation Date and Time\n" - } - ] - }, - "PmtInstrXpryDtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "Payment Instruction Expiry Date and Time\n" - } - ] - }, - "NbOfTxs": { - "allOf": [ - { - "title": "Max15NumericText", - "description": "Specifies a numeric string with a maximum length of 15 digits.\n", - "type": "string", - "pattern": "^[0-9]{1,15}$", - "example": 123456789012345 - }, - { - "description": "Number of Transactions\n" - } - ] - }, - "SttlmInf": { - "allOf": [ - { - "title": "SettlementInstruction15", - "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", - "type": "object", - "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", + "CtryOfRes": { + "allOf": [ + { + "title": "CountryCode", "type": "string", - "enum": [ - "HIGH", - "NORM" - ], - "example": "HIGH" + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, - "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": [ + { + "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": { - "Cd": { + "ChanlTp": { "allOf": [ { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level 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\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code 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\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Prtry" - ] + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + { + "description": "OtherContact\nContact details in another form.\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": [ + "PrefrdMtd": { + "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": "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": "Max35Text", - "description": "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": "PreferredContactMethod\nPreferred method used to reach the contact.\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" + ] } - ] + }, + "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" + } }, - "CtgyPurp": { - "allOf": [ - { - "title": "CategoryPurpose1Choice", - "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\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" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + { + "description": "Party that owes an amount of money to the (ultimate) creditor.\n" + } + ] + }, + "Cdtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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": "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, + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], "type": "string", - "example": 1234 + "example": "ADDR" }, { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "description": "Code\nType of address expressed as a code.\n" } ] } @@ -20468,15 +20086,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\nCategory purpose, in a proprietary form.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } @@ -20487,1263 +20157,1340 @@ } ], "example": { - "Cd": "CASH" + "Cd": "ADDR" } }, - { - "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 in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" - } - ] - }, - "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" - ] + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "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 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" - ] + "Dept": { + "title": "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\nSpecifies the local instrument, as a proprietary code.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "SubDept": { + "title": "Max70Text", + "description": "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": { - "Cd": "CH03" + "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": "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": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "CtgyPurp": { + "Id": { "allOf": [ { - "title": "CategoryPurpose1Choice", - "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\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": { + "OrgId": { "allOf": [ { - "title": "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": "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": "Proprietary\nCategory purpose, in a proprietary form.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ - "Prtry" + "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": "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": { - "Cd": "CASH" + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } } }, { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] - } - }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" }, - "LclInstrm": { - "Cd": "CORE" + "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" + } + ] }, - "CtgyPurp": { - "Cd": "CASH" - } - } - }, - { - "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" - } - ] - }, - "UndrlygCstmrCdtTrf": { - "allOf": [ - { - "title": "UnderlyingCustomerCreditTransfer", - "type": "object", - "properties": { - "InstdAmt": { + "CtctDtls": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "Contact13", + "description": "Specifies the details of the contact person.\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": { + "NmPrfx": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "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": 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})$" + "example": "DOCT" }, { - "description": "Amount of 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": "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.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\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" - } - ] - } - } - }, - { - "description": "Underlying Customer Credit Transfer\nTBD\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" + }, + "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": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ - "ActiveCurrencyAndAmount", - "Ccy" + "Id" ], "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" - } - ] + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under 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" + "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" } - }, - "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" + "description": "Party to which an amount of money is due.\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": { + "DbtrAgt": { "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", - "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 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", - "anyOf": [ + "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" - } - ] - } - }, - "required": [ - "MmbId" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": { - "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", - "anyOf": [ + "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", - "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" - } - ] + "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": [ @@ -21756,922 +21503,993 @@ "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": [ + "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": [ { - "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": [ + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "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": [ { - "description": "AddressType2Code\nSpecifies 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" - } - }, - "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": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Tp": { + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Financial institution servicing an account for the debtor.\n" + } + ] + }, + "CdtrAgt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { "allOf": [ { - "title": "ChargeType3Choice", - "description": "ChargeType3Choice\nSpecifies the type of charge.\n", + "title": "FinancialInstitutionIdentification23", "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" - } - ] + "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": "GenericIdentification3", - "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": "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": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\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" + } }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\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": { + "MmbId": { "allOf": [ { - "description": "AddressType2Code\nSpecifies 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": "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" + ] } - ] + ], + "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": "PostalAddress\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" - } - }, - { - "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": "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": "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", + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", "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" - } + "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", @@ -22682,736 +22500,595 @@ "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": "BIC" - }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + "Prtry" + ] } - ] - } - }, - "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { + ], + "example": { "Cd": "BIC" - }, - "Issr": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" } - } + ] }, - { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "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 }, - "required": [ - "OrgId" + "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" + } ] }, - { - "properties": { - "PrvtId": { - "allOf": [ - { - "title": "PersonIdentification18", - "description": "Unique and unambiguous way to identify a person.\n", + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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", - "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" - } - ] + "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" }, - "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" - } - ] + { + "description": "Code\nType of address expressed as a code.\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" + ] } + }, + "required": [ + "Cd" ] }, - "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 + { + "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": "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": [ + "Issr": { + "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": "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": "CCPT" - } + ] }, - { - "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": "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 - } - } + "Cd": "ADDR" } }, - { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\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": [ - "PrvtId" ] } - ], + }, "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" } } }, { - "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": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "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" - } + "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" } } }, { - "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" + "description": "Financial institution servicing an account for the creditor.\n" + } + ] + } + } + }, + { + "description": "Underlying Customer Credit Transfer\nTBD\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 } ] }, - "DbtrAcct": { + "Ccy": { "allOf": [ { - "title": "CashAccount40", + "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": "Provides the details to identify an account.\n", + "description": "Information used to identify a financial institution.\n", "properties": { - "Id": { + "BICFI": { "allOf": [ { - "title": "AccountIdentification4Choice", + "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": "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": [ + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\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": { + "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", - "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 - } + "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", @@ -23422,160 +23099,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", - "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" - } + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-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", + "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" } ] } @@ -23597,7 +23504,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" } ] } @@ -23608,26 +23515,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" } ] } @@ -23636,224 +23543,516 @@ "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": "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "DbtrAgt": { + "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" - }, + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "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": [ + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\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": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", "properties": { - "ClrSysId": { + "Prtry": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "title": "GenericIdentification30", "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" - } - ] + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "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" - } - ] - }, - "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": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 - } - }, - { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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" - } - ] + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies 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" - } - ] + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - "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", + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" + } + ] + }, + "DbtrAcct": { + "allOf": [ + { + "title": "CashAccount40", + "type": "object", + "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": "Choice of formats for the type of address.\n", + "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" } ] } @@ -23867,67 +24066,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" } ] } @@ -23938,90 +24085,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", @@ -24029,15 +24103,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", @@ -24045,1693 +24278,839 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies 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" - } - ] + { + "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", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": { + "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": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([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": "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": "LEI\nLegal entity identification for the branch of the 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" } ] }, - "Nm": { + "MmbId": { "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": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - "PstlAdr": { - "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": "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": [ + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "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": [ { - "description": "AddressType2Code\nSpecifies 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" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies 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" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "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": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "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": "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" - } - } - } - }, - { - "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": { + "Othr": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "GenericFinancialIdentification1", "type": "object", - "description": "Information used to identify a financial institution.\n", + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { - "BICFI": { + "Id": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "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": 35, + "example": 1.234567890123457e+34 }, { - "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": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "ClrSysMmbId": { + "SchmeNm": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "anyOf": [ + "description": "Specifies the name of the identification scheme.\n", + "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": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution 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\nProprietary identification of the clearing system.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "description": "Code\nName of the identification scheme, in a coded form 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\nName of the identification scheme, in a free text form.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "MmbId" ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Cd": "BIC" } }, { - "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" + "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": [ + "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": [ { - "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": [ + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "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": [ { - "description": "AddressType2Code\nSpecifies 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", - "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" - } - ] + "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 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" - } - ] + "Dept": { + "title": "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": "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": 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 + "SubDept": { + "title": "Max70Text", + "description": "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", @@ -25867,565 +25246,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" } ] - }, - "Id": { - "allOf": [ - { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "OrgId": { - "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": "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", + "anyOf": [ { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", "properties": { - "AnyBIC": { + "Cd": { "allOf": [ { - "title": "AnyBICDec2014Identifier", + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\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" + "minLength": 1, + "maxLength": 5, + "example": 12345 }, { - "description": "AnyBIC\nBusiness identification code of the organisation.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] - }, - "LEI": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated 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": "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" }, - "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" - } - ] + { + "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 }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "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 }, - "Issr": "BIC" - } + { + "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" + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] } - ] - } - }, - "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" }, - "Issr": "BIC" + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - } - }, - { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "OrgId" - ] + ], + "example": { + "Cd": "ADDR" + } }, - { - "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": { - "OrgId": { - "AnyBIC": "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 }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "SubDept": { + "title": "Max70Text", + "description": "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": "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": { + "Othr": { "allOf": [ { - "title": "Contact13", - "description": "Specifies the details of the contact 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": { - "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", @@ -26436,26 +25736,72 @@ "example": 1.234567890123457e+34 }, { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "JobTitl": { + "SchmeNm": { "allOf": [ { - "title": "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": "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": "JobTitle\nTitle of the function.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "Rspnsblty": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -26466,605 +25812,587 @@ "example": 1.234567890123457e+34 }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - "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" + "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", - "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" - } + "title": "Max35Text", + "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", - "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" - } - ] + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\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 + }, + "required": [ + "Cd" + ] }, { - "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" + "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": { - "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": "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": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "InstrForCdtrAgt": { + "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": "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": "FinancialInstitutionIdentification23", "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "Cd": { + "BICFI": { "allOf": [ { - "title": "ExternalCreditorAgentInstruction1Code", - "description": "Specifies the instruction given by the creditor to the creditor agent.", + "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\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\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" } ] }, - "InstrInf": { + "ClrSysMmbId": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "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": "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": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\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": { + }, + "LEI": { "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": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a 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": [ - "PHOA", - "TELA" - ], - "example": "PHOA" + "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 next agent in the payment chain.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, - "InstrInf": { + "Nm": { "allOf": [ { "title": "Max140Text", @@ -27075,163 +26403,280 @@ "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" - } - ] + "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": "Max35Text", - "description": "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": { + "PstlAdr": { "allOf": [ { - "title": "RegulatoryAuthority2", - "description": "Information about an entity requiring the regulatory reporting information.\n", + "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\n\nName of the entity requiring the regulatory reporting information.\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": { - "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" - } - ] + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } }, "example": { - "Nm": "Swiss National Bank", - "Ctry": "CH" + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "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": "Authority\n\nEntity requiring the regulatory reporting information.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\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": [ + "Othr": { + "allOf": [ { - "title": "StructuredRegulatoryReporting3", - "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\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": "Max35Text", @@ -27242,105 +26687,73 @@ "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" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Amt": { + "SchmeNm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "FinancialIdentificationSchemeName1Choice", "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" + "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": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under 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": "BIC" } }, { - "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "Inf": { - "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", - "anyOf": [ + "Issr": { + "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", @@ -27350,507 +26763,72 @@ "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" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "Tp": "T1", - "Dt": "2018-01-01", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - "Inf": 12345 + "Issr": "BIC" } }, { - "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" - } - ] - } - }, - "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": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, + "required": [], "example": { - "DbtCdtRptgInd": "CRED", - "Authrty": { - "Nm": "Swiss National Bank", - "Ctry": "CH" + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "Dtls": { - "Cd": "A1", - "Inf": "Mandatory regulatory information" + "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": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "Tax": { + "BrnchId": { "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": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\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": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -27861,1130 +26839,14140 @@ "example": 1.234567890123457e+34 }, { - "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "RefNb": { + "LEI": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 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": 140, - "example": 12345 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, - "Mtd": { + "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": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, - "TtlTaxblBaseAmt": { + "PstlAdr": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "PostalAddress27", "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 that locates and identifies a specific address, as defined by postal services.\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" - }, + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "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": "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", - "type": "string", + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" ], - "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 + "example": "ADDR" }, { - "description": "Year\n\nYear related to the tax payment.\n" + "description": "Code\nType of address expressed as a code.\n" } ] } }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - } + "required": [ + "Cd" + ] }, { - "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": { + "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", - "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})$" + "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", - "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})$" + "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": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" - } - } + } + }, + "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", + "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, - "Amt": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\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" + "Prtry" + ] } - ] - } - }, - "example": { - "Rate": 0, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 0 + ], + "example": { + "Cd": 1111 + } }, - "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 }, - "Dtls": { - "Tp": "T1", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 - }, - "Inf": 12345 + { + "description": "Issuer\nEntity that assigns the identification.\n" } - } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - { - "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": { - "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" + "Cd": "EMAIL" } }, { - "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", + "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", + "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" + } + } + }, + "CryptographicLockChoice": { + "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" + } + }, + "DateAndDateTime2Choice": { + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Dt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "Date\nSpecified date.\n" + } + ] + } + }, + "required": [ + "Dt" + ] + }, + { + "properties": { + "DtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "DateTime\nSpecified date and time.\n" + } + ] + } + }, + "required": [ + "DtTm" + ] + } + ], + "example": { + "DtTm": "2020-01-01T00:00:00Z" + } + }, + "DateAndPlaceOfBirth1": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "BirthDate\nDate on which a person was born.\n" + } + ] + }, + "PrvcOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ProvinceOfBirth\nProvince where a person was born.\n" + } + ] + }, + "CityOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "CityOfBirth\nCity where a person was born.\n" + } + ] + }, + "CtryOfBirth": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "CountryOfBirth\nCountry where a person was born.\n" + } + ] + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "DatePeriod2": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "FromDate\nStart date of the range.\n" + } + ] + }, + "ToDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "ToDate\nEnd date of the range.\n" + } + ] + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" + } + }, + "ErrorCode": { + "title": "ErrorCode", + "type": "string", + "pattern": "^[1-9]\\d{3}$", + "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.", + "example": "5100" + }, + "ErrorDescription": { + "title": "ErrorDescription", + "type": "string", + "minLength": 1, + "maxLength": 128, + "description": "Error description string." + }, + "ErrorInformation": { + "title": "ErrorInformation", + "type": "object", + "description": "Data model for the complex type ErrorInformation.", + "properties": { + "errorCode": { + "title": "ErrorCode", + "type": "string", + "pattern": "^[1-9]\\d{3}$", + "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.", + "example": "5100" + }, + "errorDescription": { + "title": "ErrorDescription", + "type": "string", + "minLength": 1, + "maxLength": 128, + "description": "Error description string." + }, + "extensionList": { + "title": "ExtensionList", + "type": "object", + "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" + ] + } + }, + "required": [ + "errorCode", + "errorDescription" + ] + }, + "ErrorInformationResponse": { + "title": "ErrorInformationResponse", + "type": "object", + "description": "Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.\n", + "properties": { + "errorInformation": { + "title": "ErrorInformation", + "type": "object", + "description": "Data model for the complex type ErrorInformation.", + "properties": { + "errorCode": { + "title": "ErrorCode", + "type": "string", + "pattern": "^[1-9]\\d{3}$", + "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.", + "example": "5100" + }, + "errorDescription": { + "title": "ErrorDescription", + "type": "string", + "minLength": 1, + "maxLength": 128, + "description": "Error description string." + }, + "extensionList": { + "title": "ExtensionList", + "type": "object", + "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" + ] + } + }, + "required": [ + "errorCode", + "errorDescription" + ] + } + } + }, + "Exact32HexBinaryText": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "example": "1234567890ABCDEF1234567890ABCDEF" + }, + "Exact4AlphaNumericText": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Execute_FIToFICustomerCreditTransferV13": { + "title": "Execute_FIToFICustomerCreditTransferV13", + "type": "object", + "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "Creation Date and Time\n" + } + ] + }, + "PmtInstrXpryDtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "Payment Instruction Expiry Date and Time\n" + } + ] + }, + "NbOfTxs": { + "allOf": [ + { + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", + "type": "string", + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 + }, + { + "description": "Number of Transactions\n" + } + ] + }, + "SttlmInf": { + "allOf": [ + { + "title": "SettlementInstruction15", + "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", + "type": "object", + "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": "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" + } + } + } + }, + "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 in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" + } + ] + }, + "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" + ] + } + ], + "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" + } + ] + }, + "UndrlygCstmrCdtTrf": { + "allOf": [ + { + "title": "UnderlyingCustomerCreditTransfer", + "type": "object", + "properties": { + "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" + } + ] + }, + "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": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "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": { + "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" + } + }, + { + "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": { + "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": "Party that owes an amount of money to the (ultimate) creditor.\n" + } + ] + }, + "Cdtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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": { + "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" + } + }, + { + "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": { + "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": "Party to which an amount of money is due.\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": { + "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 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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Financial institution servicing an account for the debtor.\n" + } + ] + }, + "CdtrAgt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "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": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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 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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Financial institution servicing an account for the creditor.\n" + } + ] + } + } + }, + { + "description": "Underlying Customer Credit Transfer\nTBD\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": "Amount of 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", + "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 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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalChargeType1Code", + "description": "Specifies the type of charge applied to the transaction.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nCharge type, in a coded form.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification3", + "type": "object", + "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": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "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": { + "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" + } + }, + { + "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": { + "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", + "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": "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" + } + ] + } + }, + "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", + "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 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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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", + "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 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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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": { + "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" + } + }, + { + "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": { + "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", + "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": "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" + } + ] + } + }, + "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" + } + ] + }, + "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})$" + }, + { + "description": "Amount of 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", + "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": "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" + } + ] + } + }, + "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" + } + } + }, + { + "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 + } + } + }, + { + "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", @@ -29001,2166 +40989,12006 @@ ], "example": "HLF1" }, - { - "description": "Type\n\nIdentification of the period related to the tax payment.\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": { + "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" + } + ] + } + }, + "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" + } + } + }, + { + "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 + } + } + }, + { + "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", + "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": [ + "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.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\",\n \"SETT\": \"SETTLED\"\n}\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": "SETT" + }, + "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": "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 + } + } + }, + "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", + "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 + } + } + }, + "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "Creation Date and Time\n" + } + ] + }, + "NbOfTxs": { + "allOf": [ + { + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", + "type": "string", + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 + }, + { + "description": "Number of Transactions\n" + } + ] + }, + "TtlIntrBkSttlmAmt": { + "allOf": [ + { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "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": [ + { + "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" + } + } + } + }, + "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 + }, + { + "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": "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", + "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 in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" + } + ] + }, + "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" + ] + } + ], + "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" + } + ] + }, + "UndrlygCstmrCdtTrf": { + "allOf": [ + { + "title": "UnderlyingCustomerCreditTransfer", + "type": "object", + "properties": { + "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" + } + ] + }, + "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": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "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": { + "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" + } + }, + { + "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": { + "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": "Party that owes an amount of money to the (ultimate) creditor.\n" + } + ] + }, + "Cdtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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": { + "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" + } + }, + { + "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": { + "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": "Party to which an amount of money is due.\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": { + "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 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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Financial institution servicing an account for the debtor.\n" + } + ] + }, + "CdtrAgt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "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": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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 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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Financial institution servicing an account for the creditor.\n" + } + ] + } + } + }, + { + "description": "Underlying Customer Credit Transfer\nTBD\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": "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 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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" + } + ] + }, + "DbtrAcct": { + "allOf": [ + { + "title": "CashAccount40", + "type": "object", + "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": "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" + } + ] + } + }, + "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": { + "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" } - ] - }, - "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": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "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": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\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": "Year\n\nYear related to the tax payment.\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", + "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" + } + ] }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } - ] - }, - "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": "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" + } + ] } }, - { - "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" + "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": "Currency\nIdentification of the currency in which the account is held.\n" + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\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" - } - ] - } + "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 }, - "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", - "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": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "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" + ] + } + ], + "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", + "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" + } + ] } }, - { - "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" - } - ] + "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 }, - "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\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" - } - ] + "Issr": { + "allOf": [ + { + "title": "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": "Issuer\nEntity that assigns the identification.\n" } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + ] }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] } - ] - } - }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - } - }, - "type": "array" - } - ] + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" } }, - "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 - } + "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": "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": { + "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" } - ] - } - }, - "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 + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } - }, - "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" + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } }, { - "description": "SHA-256 signature of the terms\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\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" + ], + "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" + } + } + } }, - "FinInstnId": { - "BICFI": "BICFI" + { + "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } - }, - "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.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\",\n \"SETT\": \"SETTLED\"\n}\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": "SETT" - }, - "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": "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", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", - "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "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": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" + } + ] }, - { - "description": "Code\nClearing system identification code, as published in an external list.\n" + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "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", - "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" + "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" } ] - } - }, - "required": [ - "Id", - "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" + "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": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\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": { + "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": { - "Cd": "BIC" + "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": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "Creditor\nParty to which an amount of money is due.\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": { + "CdtrAcct": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "title": "CashAccount40", "type": "object", - "anyOf": [ - { - "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": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", - "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "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\nClearing system identification code, as published in an external 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" + } + ] + }, + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under 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" } - }, - "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": { + }, + "Nm": { "allOf": [ { - "description": "AddressType2Code\nSpecifies 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": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "example": "ADDR" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, { - "description": "Code\nType of address expressed as a code.\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" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Prxy": { "allOf": [ { - "title": "GenericIdentification30", + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\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": { + "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 + "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": "Issuer\nEntity that assigns the identification.\n" + "description": "Type\nType of the proxy identification.\n" } ] }, - "SchmeNm": { + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ - "Id", - "Issr" + "Id" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, - "required": [ - "Prtry" - ] + "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" } - ], - "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": { + "InstrForCdtrAgt": { "allOf": [ { - "title": "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": "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": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, - "SchmeNm": { + "Purp": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "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", - "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", + "title": "ExternalPurpose1Code", + "description": "Specifies the external purpose code.", "type": "string", "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": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" } ] } @@ -31182,7 +53010,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Proprietary\n\nPurpose, in a proprietary form.\n" } ] } @@ -31193,82 +53021,257 @@ } ], "example": { - "Cd": "BIC" + "Cd": "CH03" } }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Purpose\nUnderlying reason for the payment transaction.\n" } ] }, - "Issr": { + "VrfctnOfTerms": { "allOf": [ { - "title": "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": "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": "Issuer\nEntity that assigns the identification.\n" + "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" } ] } }, "required": [ - "Id" + "PmtId", + "IntrBkSttlmAmt", + "Dbtr", + "Cdtr" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" }, - "Issr": "BIC" + "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": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "Credit Transfer Transaction Information\n" } ] } }, - "required": [], + "required": [ + "GrpHdr", + "CdtTrfTxInf" + ], "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 + "GrpHdr": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "TtlIntrBkSttlmAmt": { + "Ccy": "EUR", + "Value": 100 }, - "Issr": 123 + "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" + } + } + } } } }, - "FxRequest_FICreditTransferProposal": { - "title": "FxRequest_FICreditTransferProposal", + "FxResponse_FICreditTransferConfirmation": { + "title": "FxResponse_FICreditTransferConfirmation", "type": "object", - "description": "FxRequest_FICreditTransferProposal\nA group of elements providing information specific to the individual credit transfer(s) included in the message.\n", + "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": [ @@ -32326,486 +54329,894 @@ "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": "Underlying Customer Credit Transfer\nTBD\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": { + "Dbtr": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", - "description": "Information used to identify a financial institution.\n", "properties": { - "BICFI": { + "Nm": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "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": 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": "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", - "anyOf": [ + "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": "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" + } + }, + { + "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": "Code\nClearing system identification code, as published in an external list.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Cd" - ] + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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": "Person\nUnique and unambiguous identification of a person, for example a passport.\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": [ + "PrvtId" ] } - }, - "required": [ - "MmbId" ], "example": { - "ClrSysId": { - "Cd": "CHQB" + "OrgId": { + "AnyBIC": "BIC" }, - "MmbId": 123456789 + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } } }, { - "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" + "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, - "Nm": { + "CtryOfRes": { "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": "Name\nName by which an agent is known and which is usually used to identify that agent\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" } ] }, - "PstlAdr": { + "CtctDtls": { "allOf": [ { - "title": "PostalAddress24", + "title": "Contact13", + "description": "Specifies the details of the contact person.\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", - "anyOf": [ + "NmPrfx": { + "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" - ] + "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": { - "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": "NamePrefix\nSpecifies the terms used to formally address a person.\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 + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies 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" + } + ] }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 + "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" + } + ] }, - "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 + "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" + } + ] }, - "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 + "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" + } + ] }, - "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 + "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" + } + ] }, - "CtrySubDvsn": { - "title": "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" + } + ] }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\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" + } + ] }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies 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": { + "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", @@ -32816,176 +55227,163 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, - "SchmeNm": { + "Dept": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "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", - "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" - } - ] + "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": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, - "BrnchId": { + "Cdtr": { "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": [ { @@ -32997,7 +55395,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" } ] }, @@ -33251,886 +55649,1357 @@ "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] - } - }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } - } - }, - { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" - } - ] - } - }, - "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - } - }, - { - "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" - } - ] - }, - "DbtrAcct": { - "allOf": [ - { - "title": "CashAccount40", - "type": "object", - "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" + "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": [ - "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": { + }, + "Id": { "allOf": [ { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", "type": "object", "anyOf": [ { "properties": { - "Cd": { + "OrgId": { "allOf": [ { - "title": "ExternalProxyAccountType1Code", - "description": "Specifies the external proxy account type code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "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": "Code\nProxy account type, in a coded form as published in an external list.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ - "Cd" + "OrgId" ] }, { "properties": { - "Prtry": { + "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": "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": "Proprietary\nProxy account type, in a proprietary form.\n" + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ - "Prtry" + "PrvtId" ] } ], "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 + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } }, { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + "description": "Identification\nUnique and unambiguous identification of a 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": "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": { + "CtryOfRes": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "title": "CountryCode", "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" + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\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" + "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" } ] }, - "ClrSysMmbId": { + "CtctDtls": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", "type": "object", "properties": { - "ClrSysId": { + "NmPrfx": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\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\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", - "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" - } - ] + "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\nProprietary identification of the clearing system.\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": "CHIPS" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "OtherContact\nContact details in another form.\n" } ] }, - "MmbId": { + "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": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, - "required": [ - "MmbId" - ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "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": "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" + "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" }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies 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" + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" } - ] + } }, - "PstlAdr": { + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + { + "description": "Party to which an amount of money is due.\n" + } + ] + }, + "DbtrAgt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { "allOf": [ { - "title": "PostalAddress24", + "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", - "anyOf": [ + "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": "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": [ { - "description": "AddressType2Code\nSpecifies 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": "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" + ] } - ] + ], + "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\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 + "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": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "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 or a branch of a financial institution.\n" } ] }, - "Othr": { + "BrnchId": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\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": [ @@ -34143,945 +57012,945 @@ "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", - "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" - } + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-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": "LEI\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", - "anyOf": [ + "PstlAdr": { + "allOf": [ { + "title": "PostalAddress27", + "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": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\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\nType of address expressed as a 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" + } + }, + "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": [ - "Cd" - ] + "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" + } }, { - "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": "PostalAddress\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, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\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": "Financial institution servicing an account for the debtor.\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": { + "CdtrAgt": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", - "description": "Information used to identify a financial institution.\n", + "description": "Unique and unambiguous identification of a financial institution or a branch of 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": { + "FinInstnId": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "FinancialInstitutionIdentification23", "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "ClrSysId": { + "BICFI": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\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", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", - "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "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\nClearing system identification code, 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\nProprietary identification of the clearing system.\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": "CHIPS" + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "MmbId": { + "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": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "LEI\nLegal entity identifier of the financial 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", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ + "Nm": { + "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": "Max140Text", + "description": "Specifies 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": { + "Cd": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a 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", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "example": "ADDR" }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "Issr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "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": "Issuer\nEntity that assigns the identification.\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" ] }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum 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 or a branch of a financial institution.\n" } ] }, - "Othr": { + "BrnchId": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\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": [ @@ -35094,522 +57963,423 @@ "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", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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 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" + "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" ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\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": [ - "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": { - "Cd": "BIC" + "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": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, - "required": [ - "Id" - ], "example": { "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, - "required": [], + "required": [ + "FinInstnId" + ], "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" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Othr": { + "BrnchId": { "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "Financial institution servicing an account for the creditor.\n" + } + ] + } + } + }, + { + "description": "Underlying Customer Credit Transfer\nTBD\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 } ] }, - "BrnchId": { + "Ccy": { "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "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": "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": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ - "FinInstnId" + "ActiveCurrencyAndAmount", + "Ccy" ], "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" - } - } + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" + "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" } ] }, - "Cdtr": { + "Dbtr": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", @@ -36556,11 +59326,11 @@ } }, { - "description": "Creditor\nParty to which an amount of money is due.\n" + "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" } ] }, - "CdtrAcct": { + "DbtrAcct": { "allOf": [ { "title": "CashAccount40", @@ -36932,537 +59702,512 @@ } }, { - "description": "CreditorAccount\nAccount to which a credit entry is made.\n" + "description": "DebtorAccount\nAccount used to process a payment.\n" } ] }, - "InstrForCdtrAgt": { + "DbtrAgt": { "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": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "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": { + "FinInstnId": { "allOf": [ { - "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 + "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": "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 + "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" + } + ] }, - { - "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}$" + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": "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" + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies 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" + } + ] }, - { - "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", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "Creation Date and Time\n" - } - ] - }, - "NbOfTxs": { - "allOf": [ - { - "title": "Max15NumericText", - "description": "Specifies a numeric string with a maximum length of 15 digits.\n", - "type": "string", - "pattern": "^[0-9]{1,15}$", - "example": 123456789012345 - }, - { - "description": "Number of Transactions\n" - } - ] - }, - "TtlIntrBkSttlmAmt": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "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": [ + "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": "ExternalServiceLevel1Code", - "description": "Specifies the external service level 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": "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": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -37473,396 +60218,752 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\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": "SEPA" - } + ] + } + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\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 } - ] + } }, - "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": [ + { + "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": [ { - "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": "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\nSpecifies the local instrument, as a proprietary code.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\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": [ + "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 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": { - "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" + "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 } }, - "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" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } - ], - "example": { - "Cd": "CASH" - } - }, - { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" } - ] - } - }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" + } }, - "CtgyPurp": { - "Cd": "CASH" + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } - } + ] } }, "required": [ - "SttlmMtd" + "FinInstnId" ], "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 - } + "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": "Settlement Information\n" + "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" } ] }, - "PmtTpInf": { + "CdtrAgt": { "allOf": [ { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "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": { + "FinInstnId": { "allOf": [ { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", + "title": "FinancialInstitutionIdentification23", "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" - } - ] + "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": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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": "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": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + { + "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", - "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" - } - ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies 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": [ - "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, + }, + "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", - "example": 1234 + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "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", @@ -37870,259 +60971,39 @@ "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", - "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 in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" - } - ] - }, - "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.", + "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\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": [ - { + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "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", @@ -38130,60 +61011,15 @@ "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.", + "TwnLctnNm": { + "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": [ - { + "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -38191,215 +61027,588 @@ "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, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", "type": "string", - "example": 1234 + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, - { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "AdrLine": { + "title": "Max70Text", + "description": "Specifies 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": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "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": [ + { + "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" + } + ] }, - { - "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": [ + "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": "CASH" + "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": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] - } - }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" }, - "LclInstrm": { - "Cd": "CORE" - }, - "CtgyPurp": { - "Cd": "CASH" - } - } - }, - { - "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" - } - ] - }, - "UndrlygCstmrCdtTrf": { - "allOf": [ - { - "title": "UnderlyingCustomerCreditTransfer", - "type": "object", - "properties": { - "InstdAmt": { + "BrnchId": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "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 or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { - "ActiveOrHistoricCurrencyAndAmount": { + "Id": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "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})$" + "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": "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.\n" + "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": 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": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "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": "Underlying Customer Credit Transfer\nTBD\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" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "ActiveCurrencyAndAmount", - "Ccy" + "FinInstnId" ], "example": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" + "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": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" + "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, - "Dbtr": { + "Cdtr": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", @@ -39346,11 +62555,11 @@ } }, { - "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" + "description": "Creditor\nParty to which an amount of money is due.\n" } ] }, - "DbtrAcct": { + "CdtrAcct": { "allOf": [ { "title": "CashAccount40", @@ -39722,107 +62931,497 @@ } }, { - "description": "DebtorAccount\nAccount used to process a payment.\n" + "description": "CreditorAccount\nAccount to which a credit entry is made.\n" } ] }, - "DbtrAgt": { + "InstrForCdtrAgt": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "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", - "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" - } - ] + "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 }, - "ClrSysMmbId": { - "allOf": [ + { + "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "Creation Date and Time\n" + } + ] + }, + "PmtInstrXpryDtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "Payment Instruction Expiry Date and Time\n" + } + ] + }, + "NbOfTxs": { + "allOf": [ + { + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", + "type": "string", + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 + }, + { + "description": "Number of Transactions\n" + } + ] + }, + "SttlmInf": { + "allOf": [ + { + "title": "SettlementInstruction15", + "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", + "type": "object", + "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": "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", - "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" - } + "title": "ExternalServiceLevel1Code", + "description": "Specifies the external service level code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\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" } ] - }, - "MmbId": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -39833,401 +63432,117 @@ "example": 1.234567890123457e+34 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary 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 - }, - { - "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" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "SEPA" + } }, - "Othr": { - "allOf": [ + { + "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": [ { - "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": "ExternalLocalInstrument1Code", + "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, - "example": 1.234567890123457e+34 + "example": 12345 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\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" - } + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] - }, - "Issr": { + } + }, + "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", @@ -40238,346 +63553,412 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nCategory purpose, 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" + "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": "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": 123, - "Prtry": 123 - }, - "Issr": 123 + "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\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" } ] }, - "BrnchId": { + "EndToEndId": { "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "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", + "title": "Max35Text", + "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 in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" + } + ] + }, + "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": 140, - "example": 12345 + "maxLength": 4, + "example": 1234 }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\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": 16, - "example": 1234567890123456 + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\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": 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", @@ -40585,239 +63966,108 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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" - } - }, - { - "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": "CASH" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, - "required": [ - "FinInstnId" - ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" }, - "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" - } + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" } } }, { - "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" + "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" } ] }, - "CdtrAgt": { + "UndrlygCstmrCdtTrf": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "UnderlyingCustomerCreditTransfer", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FinInstnId": { + "InstdAmt": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", - "description": "Information used to identify a financial institution.\n", + "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": { - "BICFI": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "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 - } + "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": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\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" } ] }, - "LEI": { + "Ccy": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated 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": "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 identifier of the financial institution.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] - }, + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Dbtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { "Nm": { "allOf": [ { @@ -40829,14 +64079,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": "PostalAddress24", + "title": "PostalAddress27", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -40951,6 +64201,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", @@ -40968,12 +64226,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", @@ -40984,12 +64242,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", @@ -40999,6 +64257,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", @@ -41024,28 +64290,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", @@ -41073,12 +64339,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", @@ -41091,640 +64359,565 @@ } }, { - "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" } ] }, - "Othr": { + "Id": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\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", - "anyOf": [ + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ { + "title": "OrganisationIdentification39", + "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" - ] - }, - { - "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\nName of the identification scheme, in a free text form.\n" + "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": [ - "Prtry" - ] + "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": { - "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": [ + "OrgId" ] - } - }, - "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": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" + { + "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" + } + ] }, - { - "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": "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" + } + ] }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "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": "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" + } + ] }, - { - "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": "DRLC" }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] + "Issr": "BIC" + } + }, + { + "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" - } + ] + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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": "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": [ + "PrvtId" + ] } - }, + ], "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" + "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" } ] - } - }, - "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": { + }, + "CtryOfRes": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "title": "CountryCode", "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" + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\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" + "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" } ] }, - "ClrSysMmbId": { + "CtctDtls": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", "type": "object", "properties": { - "ClrSysId": { + "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": "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" - } + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, - "MmbId": { + "EmailPurp": { "allOf": [ { "title": "Max35Text", @@ -41735,325 +64928,26 @@ "example": 1.234567890123457e+34 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "EmailPurpose\nPurpose for which an email address may be used.\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": [ + "JobTitl": { + "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": "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": "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": "JobTitle\nTitle of the function.\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": { + "Rspnsblty": { "allOf": [ { "title": "Max35Text", @@ -42064,176 +64958,163 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, - "SchmeNm": { + "Dept": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "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", - "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" - } - ] + "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" + ] + } + }, + "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": "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": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, - "BrnchId": { + "Cdtr": { "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": [ { @@ -42245,7 +65126,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" } ] }, @@ -42525,1559 +65406,2654 @@ } }, { - "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", - "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" - } - ] + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } - }, - "required": [ - "IBAN" ] }, - { - "properties": { - "Othr": { - "allOf": [ + "Id": { + "allOf": [ + { + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\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": "OrganisationIdentification39", + "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", - "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" - } - ] + "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 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" - } - ] + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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" } - }, - "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": "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 + }, + "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": "Code\nProxy account type, in a coded form as published in an external list.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ - "Cd" + "OrgId" ] }, { "properties": { - "Prtry": { + "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": "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": "Proprietary\nProxy account type, in a proprietary form.\n" + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ - "Prtry" + "PrvtId" ] } ], "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", - "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" + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + { + "description": "Identification\nUnique and unambiguous identification of a party.\n" + } + ] }, - { - "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", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "Creation Date and Time\n" - } - ] - }, - "PmtInstrXpryDtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "Payment Instruction Expiry Date and Time\n" - } - ] - }, - "NbOfTxs": { - "allOf": [ - { - "title": "Max15NumericText", - "description": "Specifies a numeric string with a maximum length of 15 digits.\n", - "type": "string", - "pattern": "^[0-9]{1,15}$", - "example": 123456789012345 - }, - { - "description": "Number of Transactions\n" - } - ] - }, - "SttlmInf": { - "allOf": [ - { - "title": "SettlementInstruction15", - "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", - "type": "object", - "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" + "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": "HIGH" + "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" + } + } }, - "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" + { + "description": "Party to which an amount of money is due.\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": { + "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 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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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": "RTGS" + "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" + } + } + } }, - "SvcLvl": { - "allOf": [ - { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", - "type": "object", - "anyOf": [ + { + "description": "Financial 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": { - "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", - "anyOf": [ - { - "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 + "maxLength": 140, + "example": 12345 }, { - "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\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": { + }, + "PstlAdr": { "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": "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": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "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 - }, - { - "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 in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" - } - ] - }, - "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" - ] - } - ], - "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" + "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\nCategory purpose, in a proprietary form.\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": "CASH" - } - }, - { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" - } - ] - } - }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" - }, - "CtgyPurp": { - "Cd": "CASH" - } - } - }, - { - "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" - } - ] - }, - "UndrlygCstmrCdtTrf": { - "allOf": [ - { - "title": "UnderlyingCustomerCreditTransfer", - "type": "object", - "properties": { - "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" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "Ccy": { + "BrnchId": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under 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" + "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "FinInstnId" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "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": "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": "Financial institution servicing an account for the creditor.\n" } ] } @@ -67769,265 +91745,1381 @@ } }, { - "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": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Agent\nFinancial institution servicing an account for a party.\n" + } + ] + } + }, + "required": [ + "Pty" + ], + "example": { + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" + }, + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } + } + } + }, + { + "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n" + } + ] + } + }, + "required": [ + "OrgnlId", + "Vrfctn" + ], + "example": { + "OrgnlId": 1.2345678901234568e+33, + "Vrfctn": true, + "OrgnlPtyAndAcctId": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "1234 Elm St", + "BldgNb": 1234, + "PstCd": 12345, + "TwnNm": "Anytown", + "CtrySubDvsn": "CA", + "Ctry": "US" + }, + "Id": { + "OrgId": { + "AnyBIC": "ABCDUS33", + "Othr": { + "Id": 123456789, + "Issr": "ABA" + } + } + } + }, + "UpdtdPtyAndAcctId": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "1234 Elm St", + "BldgNb": 1234, + "PstCd": 12345, + "TwnNm": "Anytown", + "CtrySubDvsn": "CA", + "Ctry": "US" + }, + "Id": { + "OrgId": { + "AnyBIC": "ABCDUS33", + "Othr": { + "Id": 123456789, + "Issr": "ABA" + } + } + } + } + } + }, + { + "description": "Report\nInformation concerning the verification of the identification data for which verification was requested.\n" + } + ] + }, + "SplmtryData": { + "allOf": [ + { + "title": "SupplementaryData1", + "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "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": { + "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "Creation Date and Time\n" + } + ] + }, + "NbOfTxs": { + "allOf": [ + { + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", + "type": "string", + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 + }, + { + "description": "Number of Transactions\n" + } + ] + }, + "TtlIntrBkSttlmAmt": { + "allOf": [ + { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "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": [ + { + "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": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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 + } + } + } + } + }, + { + "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 + }, + { + "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 }, - "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\nCategory purpose, in a proprietary form.\n" } - } - }, - { - "description": "Agent\nFinancial institution servicing an account for a party.\n" + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Pty" ], "example": { - "Pty": { - "Id": { - "OrgId": { - "AnyBIC": { - "BICFI": "BICFI" - } - } - }, - "CtryOfRes": "FI" - }, - "Acct": { - "Id": { - "IBAN": "FI2112345600000785" - } - }, - "Agt": { - "FinInstnId": { - "BICFI": "BICFI" - } - } + "Cd": "CASH" } }, { - "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n" + "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, - "required": [ - "OrgnlId", - "Vrfctn" - ], "example": { - "OrgnlId": 1.2345678901234568e+33, - "Vrfctn": true, - "OrgnlPtyAndAcctId": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "1234 Elm St", - "BldgNb": 1234, - "PstCd": 12345, - "TwnNm": "Anytown", - "CtrySubDvsn": "CA", - "Ctry": "US" - }, - "Id": { - "OrgId": { - "AnyBIC": "ABCDUS33", - "Othr": { - "Id": 123456789, - "Issr": "ABA" - } - } - } + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" }, - "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" - } - } - } + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" } } }, { - "description": "Report\nInformation concerning the verification of the identification data for which verification was requested.\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 + }, + "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" } ] }, - "SplmtryData": { + "CreDtTm": { "allOf": [ { - "title": "SupplementaryData1", - "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "CreationDateTime\nDate and time at which the message was created.\n" + } + ] + } + }, + "required": [ + "MsgId", + "CreDtTm" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z" + } + }, + "GroupHeader129": { + "title": "GroupHeader129", + "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n", + "type": "object", + "properties": { + "MsgId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Message Identification\n" + } + ] + }, + "CreDtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "Creation Date and Time\n" + } + ] + }, + "PmtInstrXpryDtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "Payment Instruction Expiry Date and Time\n" + } + ] + }, + "NbOfTxs": { + "allOf": [ + { + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", + "type": "string", + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 + }, + { + "description": "Number of Transactions\n" + } + ] + }, + "SttlmInf": { + "allOf": [ + { + "title": "SettlementInstruction15", + "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", "type": "object", "properties": { - "PlcAndNm": { - "allOf": [ - { - "title": "Max350Text", - "description": "Specifies a character string with a maximum length of 350 characters.\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" + }, + "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", - "minLength": 1, - "maxLength": 350, - "example": 350 + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" }, - { - "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" + "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" + ] + } + ], + "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" + } + ] } - ] - }, - "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" + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" }, - { - "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" + "CtgyPurp": { + "Cd": "CASH" } - ] + } } }, "required": [ - "Envlp" + "SttlmMtd" ], "example": { - "PlcAndNm": "Additional information", - "Envlp": { - "Cd": "CH03", - "Prtry": "Additional information" + "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": "SupplementaryData\nAdditional information that cannot be captured in the structured elements and/or any other specific block.\n" + "description": "Settlement Information\n" } ] } }, "required": [ - "Assgnmt", - "Rpt" + "MsgId", + "CreDtTm", + "NbOfTxs", + "SttlmInf" ], "example": { - "Assgnmt": { - "MsgId": 123, - "CreDtTm": "2020-01-01T00:00:00Z", - "Assgnr": { - "OrgId": { - "Othr": { - "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 } }, - "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" - } - } + "SttlmAcctOwnr": { + "Nm": "John Doe" + }, + "SttlmAcctSvcr": { + "BICFI": 123 } } } }, - "GroupHeader113": { - "title": "GroupHeader113", - "description": "Set of characteristics shared by all individual transactions included in the message.\n", + "IBAN2007Identifier": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "example": "FR1420041010050500013M02606", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" + }, + "ISODate": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ISODateTime": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + "ISOYear": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "IdentificationAssignment3": { + "title": "IdentificationAssignment3", "type": "object", + "description": "IdentificationAssignment\nInformation that unambiguously identifies a message, as assigned by the assignor to the assignee.\n", "properties": { "MsgId": { "allOf": [ @@ -68040,7 +93132,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Message Identification\n" + "description": "MessageIdentification\nUnique identification, as assigned by the assigner, to unambiguously identify the message.\n" } ] }, @@ -68054,150 +93146,248 @@ "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" + "description": "CreationDateTime\nDate and time at which the identification assignment was created.\n" } ] }, - "SttlmInf": { + "Assgnr": { "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": "Party40Choice", + "description": "Identification of a person, an organisation or a financial institution.\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", + "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": { + "Pty": { "allOf": [ { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", + "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": 4, - "example": 1234 + "maxLength": 35, + "example": 1.234567890123457e+34 }, - { - "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": [ - { + "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -68205,671 +93395,1961 @@ "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.", + "CtrySubDvsn": { + "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" + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies 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": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "Id": { + "allOf": [ + { + "title": "Party38Choice", + "description": "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": { + "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" + } + ] + } + }, + "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" + ] }, { - "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" + "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": [ - "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 + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" }, - { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } - ] + } + }, + { + "description": "Identification\nUnique and unambiguous way to identify an 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 - }, - { - "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", - "anyOf": [ - { - "properties": { - "Cd": { + "CtryOfRes": { "allOf": [ { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", + "title": "CountryCode", "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\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" + "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": { + }, + "CtctDtls": { "allOf": [ { - "title": "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": "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": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" + "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\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" + "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" } - }, - "required": [ - "Cd" - ] + } }, { + "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": { - "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 + "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": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" + "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": "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": { + }, + "BrnchId": { "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": "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": "Code\nCategory purpose, as published in an external category purpose code list.\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": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "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" + } } - }, - "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": "Agent\nIdentification of a financial institution.\n" + } + ] } + }, + "required": [ + "Agt" ] } - }, + ], "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" + "Pty": { + "Nm": "Name", + "PstlAdr": { + "Ctry": "US", + "AdrLine": [ + "Line1", + "Line2" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + } + } }, - "CtgyPurp": { - "Cd": "CASH" + "Agt": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } } } }, { - "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", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "CreationDateTime\nDate and time at which the message was created.\n" - } - ] - } - }, - "required": [ - "MsgId", - "CreDtTm" - ], - "example": { - "MsgId": 12345, - "CreDtTm": "2020-01-01T00:00:00Z" - } - }, - "GroupHeader129": { - "title": "GroupHeader129", - "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n", - "type": "object", - "properties": { - "MsgId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Message Identification\n" - } - ] - }, - "CreDtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "Creation Date and Time\n" - } - ] - }, - "PmtInstrXpryDtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "Payment Instruction Expiry Date and Time\n" - } - ] - }, - "NbOfTxs": { - "allOf": [ - { - "title": "Max15NumericText", - "description": "Specifies a numeric string with a maximum length of 15 digits.\n", - "type": "string", - "pattern": "^[0-9]{1,15}$", - "example": 123456789012345 - }, - { - "description": "Number of Transactions\n" + "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n" } ] }, - "SttlmInf": { + "Assgne": { "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": "Party40Choice", + "description": "Identification of a person, an organisation or a financial institution.\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", + "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": { + "Pty": { "allOf": [ { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "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", @@ -68877,60 +95357,55 @@ "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.", + "Flr": { + "title": "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": 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": [ - { + "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -68938,587 +95413,863 @@ "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, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", "type": "string", - "example": 1234 + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, - { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "AdrLine": { + "title": "Max70Text", + "description": "Specifies 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": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "Id": { + "allOf": [ + { + "title": "Party38Choice", + "description": "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": { + "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" + } + ] + } + }, + "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": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 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" }, - { - "description": "Proprietary\nCategory purpose, in a proprietary form.\n" + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } - ] + } + }, + { + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } - }, - "required": [ - "Prtry" ] - } - ], - "example": { - "Cd": "CASH" - } - }, - { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" - } - ] - } - }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" - }, - "CtgyPurp": { - "Cd": "CASH" - } - } - } - }, - "required": [ - "SttlmMtd" - ], - "example": { - "SttlmMtd": "INDA", - "PmtTpInf": { - "InstrPrty": "NORM", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CH03" - }, - "CtgyPurp": { - "Cd": "SUPP" - }, - "Cdtr": { - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "AdrLine": "Address", - "Ctry": "CH" - }, - "Id": { - "OrgId": { - "AnyBIC": "BIC", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN", - "Issr": "BIC" - } - } - } - }, - "CtryOfRes": "CH", - "CtctDtls": { - "Nm": "Name", - "PhneNb": 123, - "EmailAdr": null - } - } - } - } - }, - { - "description": "Settlement Information\n" - } - ] - } - }, - "required": [ - "MsgId", - "CreDtTm", - "NbOfTxs", - "SttlmInf" - ], - "example": { - "MsgId": 12345, - "CreDtTm": "2020-01-01T00:00:00Z", - "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", - "NbOfTxs": 1, - "SttlmInf": { - "SttlmMtd": "INDA", - "SttlmAcct": { - "Id": { - "IBAN": 123 - } - }, - "SttlmAcctOwnr": { - "Nm": "John Doe" - }, - "SttlmAcctSvcr": { - "BICFI": 123 - } - } - } - }, - "IBAN2007Identifier": { - "title": "IBAN2007Identifier", - "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", - "type": "string", - "example": "FR1420041010050500013M02606", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" - }, - "ISODate": { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - "ISODateTime": { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - "ISOYear": { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", - "type": "string", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 - }, - "IdentificationAssignment3": { - "title": "IdentificationAssignment3", - "type": "object", - "description": "IdentificationAssignment\nInformation that unambiguously identifies a message, as assigned by the assignor to the assignee.\n", - "properties": { - "MsgId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "MessageIdentification\nUnique identification, as assigned by the assigner, to unambiguously identify the message.\n" - } - ] - }, - "CreDtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "CreationDateTime\nDate and time at which the identification assignment was created.\n" - } - ] - }, - "Assgnr": { - "allOf": [ - { - "title": "Party40Choice", - "description": "Identification of a person, an organisation or a financial institution.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "Pty": { - "allOf": [ - { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "properties": { - "Nm": { + }, + "CtryOfRes": { "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": "Name\nName by which a party is known and which is usually used to identify that party.\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" } ] }, - "PstlAdr": { + "CtctDtls": { "allOf": [ { - "title": "PostalAddress24", + "title": "Contact4", + "description": "Specifies the details of the contact person.\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", - "anyOf": [ + "NmPrfx": { + "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" - ] + "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": { - "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": "NamePrefix\nName prefix to be used before the name of the person.\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 + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies 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" + } + ] }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 + "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" + } + ] }, - "Room": { - "title": "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" + } + ] }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 + "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" + } + ] }, - "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 + "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" + } + ] }, - "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 + "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" + } + ] }, - "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 + "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" + } + ] }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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" + } + ] }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\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" + } + ] }, - "AdrLine": { - "title": "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": { + "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": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\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" + } + } + } + }, + "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": "Party38Choice", - "description": "Nature or use of the account.\n", + "title": "FinancialInstitutionIdentification18", "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": [ + "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": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "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": "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": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -69529,224 +96280,401 @@ "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\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" }, - "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": "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 }, - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\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" } - }, - "anyOf": [ + ] + }, + "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": "PersonIdentification13", - "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": "GenericPersonIdentification1", - "type": "object", - "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { - "Id": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -69757,1503 +96685,2402 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\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" + } + }, + { + "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" }, - "SchmeNm": { - "allOf": [ - { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "type": "object", - "anyOf": [ + { + "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": [ { - "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": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } - ], - "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 + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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": "Issuer\nEntity that assigns the identification.\n" + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, + ], "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } + "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": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\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": [ - "PrvtId" - ] - } - ], - "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\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": [ + "Prtry" ] - }, - "CtctDtls": { + } + ], + "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": "Contact4", - "description": "Specifies the details of the contact person.\n", + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\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": { + "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": "JobTitle\nTitle of the function.\n" + "description": "AnyBIC\nBusiness identification code of the organisation.\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 as an alternate identification for a party.\n" } ] }, - "Dept": { + "Othr": { "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": "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": "Department\nIdentification of a division of a large organisation or building.\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" + }, + "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": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", "type": "object", "properties": { - "ChanlTp": { + "BirthDt": { "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", + "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": 4, - "example": 1234 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, - "Id": { + "CityOfBirth": { "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": "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": [ - "ChanlTp" + "BirthDt", + "CityOfBirth", + "CtryOfBirth" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" } }, { - "description": "Other\nContact details in another form.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, - "PrefrdMtd": { + "Othr": { "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" + "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": "CELL" + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } }, { - "description": "PreferredMethod\nPreferred method used to reach the contact.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an 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" + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } } }, { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\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" + "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" }, - "Id": { - "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Prtry": "DfspId" - } + { + "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 } }, - "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\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": "Party\nIdentification of a person or an organisation.\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": [ - "Pty" ] + } + }, + "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" }, - { - "properties": { - "Agt": { - "allOf": [ + "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": [ { - "title": "BranchAndFinancialInstitutionIdentification6", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FinInstnId": { + "IBAN": { "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", - "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" - } + "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Identification\nIdentification assigned by an institution.\n" } ] }, - "Othr": { + "SchmeNm": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "AccountSchemeName1Choice", "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" + "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" ] }, - "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "anyOf": [ + { + "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" + ] } + }, + "required": [ + "Prtry" ] - }, - "Issr": { + } + ], + "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": "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" + } + ] + } + }, + "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", + "anyOf": [ + { + "properties": { + "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 + "maxLength": 5, + "example": 12345 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" - } + "Cd" + ] }, { - "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" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" + } }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + { + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } - } + ] }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\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 + } }, - "BrnchId": { - "allOf": [ - { - "title": "BranchData3", + { + "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": "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" + "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" ] }, - "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", + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", "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" - } - ] + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "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": "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" - } - ] + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length 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": "ADDR" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "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": "Proprietary\nType of address expressed as a proprietary code.\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": [ + "Prtry" ] } - }, + ], "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" - } + "Cd": "ADDR" } }, - { - "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" + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "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": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { + }, + "example": { "AdrTp": "ADDR", - "Dept": "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" } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } - } + ] }, - { - "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 + "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" + } + ] }, - { - "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", + "SchmeNm": { + "allOf": [ + { + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "description": "Choice of formats for the type of address.\n", + "description": "Specifies the 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": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution 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" } ] } @@ -71267,67 +99094,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" } ] } @@ -71338,106 +99113,17 @@ } ], "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": { - "title": "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", @@ -71445,1260 +99131,1398 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\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 }, - "Id": { - "allOf": [ - { - "title": "Party38Choice", - "description": "Nature or use of the account.\n", + { + "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": { - "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" - } - ] - } - }, - "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": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ - "OrgId" + "Cd" ] }, { "properties": { - "PrvtId": { + "Prtry": { "allOf": [ { - "title": "PersonIdentification13", - "description": "Unique and unambiguous way to identify a person.\n", + "title": "GenericIdentification30", "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "DtAndPlcOfBirth": { + "Id": { "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": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "Othr": { + "Issr": { "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" - } + "title": "Max35Text", + "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": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, + "required": [ + "Id", + "Issr" + ], "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "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 }, - "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": "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 }, - "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" - } - ] + { + "description": "Proprietary\nName of the identification scheme, in a free text 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" + ] + } + }, + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + } + ] + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "OrganisationIdentification39": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "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 }, - "Id": { - "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Prtry": "DfspId" - } - } - } + { + "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 }, - "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": "Proprietary\nName of the identification scheme, in a free text form.\n" } + ] + } + }, + "anyOf": [ + { + "properties": { + "Cd": {} } }, { - "description": "Party\nIdentification of a person or an organisation.\n" + "properties": { + "Prtry": {} + } } - ] + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\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", - "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" - } - ] + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "CreationDateTime\nDate and time at which the message was created.\n" + } + ] + } + }, + "required": [ + "MsgId", + "CreDtTm" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z" + } + }, + { + "description": "Set of characteristics shared by all individual transactions included in the message.\n" + } + ] + }, + "TxInfAndSts": { + "allOf": [ + { + "title": "PaymentTransaction163", + "description": "Provides further details on the original transactions, to which the status report message refers.\n", + "type": "object", + "properties": { + "StsId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Unique identification, as assigned by the original sending party, to unambiguously identify the status report.\n" + } + ] + }, + "OrgnlInstrId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original instruction.\n\n(FSPIOP equivalent: transactionRequestId)\n" + } + ] + }, + "OrgnlEndToEndId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original end-to-end transaction.\n\n(FSPIOP equivalent: transactionId)\n" + } + ] + }, + "OrgnlTxId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original transaction.\n\n(FSPIOP equivalent: quoteId)\n" + } + ] + }, + "OrgnlUETR": { + "allOf": [ + { + "title": "UUIDv4Identifier", + "type": "string", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" + }, + { + "description": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n" + } + ] + }, + "TxSts": { + "allOf": [ + { + "title": "ExternalPaymentTransactionStatus1Code", + "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\",\n \"SETT\": \"SETTLED\"\n}\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": "SETT" + }, + { + "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 }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress24", + { + "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": "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" - } - ] + "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": [ - "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", - "anyOf": [ + { + "properties": { + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution 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" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -72709,133 +100533,148 @@ "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": "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": "ADDR" } }, - { - "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", + "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": 35, - "example": 1.234567890123457e+34 + "maxLength": 16, + "example": 1234567890123456 }, - { - "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", + "TwnNm": { + "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": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { + "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", @@ -72843,74 +100682,275 @@ "maxLength": 140, "example": 12345 }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + "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", - "anyOf": [ + "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" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": [ - "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": "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", @@ -72921,11 +100961,141 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\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": [ + "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", @@ -72936,117 +101106,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", @@ -73054,7 +101304,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", @@ -73062,7 +101319,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", @@ -73070,795 +101334,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 - } - }, - "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" + "description": "Department\nIdentification of a division of a large organisation or building.\n" } - ] - }, - "Issr": { - "allOf": [ - { - "title": "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": [ + { + "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": "Issuer\nEntity that assigns the identification.\n" + "description": "OtherContact\nContact details in another form.\n" } ] }, - "SchmeNm": { + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, - "required": [ - "Id", - "Issr" - ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "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": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ - "Prtry" - ] + "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" } - ], - "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": [ + "Rsn": { + "allOf": [ + { + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", + "type": "object", + "anyOf": [ { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", "properties": { - "AnyBIC": { + "Cd": { "allOf": [ { - "title": "AnyBICDec2014Identifier", + "title": "ExternalStatusReason1Code", + "description": "Specifies the external status reason code.", "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" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "AnyBIC\nBusiness identification code of the organisation.\n" + "description": "Code\nReason for the status, as published in an external reason code list.\n" } ] - }, - "LEI": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated 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" - }, - { - "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" - } + "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": "Proprietary\nReason for the status, in a proprietary form.\n" } ] } }, - "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } - } + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + { + "description": "Reason\nSpecifies the reason for the status report.\n" + } + ] + }, + "AddtlInf": { + "allOf": [ + { + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 105, + "example": 12345 + }, + { + "description": "AdditionalInformation\nAdditional information about the status report.\n" + } + ] + } + }, + "example": { + "Orgtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "SubDepartment", + "StrtNm": "StreetName", + "BldgNb": "BuildingNumber", + "PstCd": "PostCode", + "TwnNm": "TownName", + "CtrySubDvsn": "CountrySubDivision", + "Ctry": "Country" + } + }, + "Rsn": { + "Cd": "AGNT" + }, + "AddtlInf": "AdditionalInformation" + } + }, + { + "description": "Information concerning the reason for the status.\n" + } + ] + }, + "AccptncDtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "Date and time at which the status was accepted.\n" + } + ] + }, + "AcctSvcrRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" + } + ] + }, + "ExctnConf": { + "allOf": [ + { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string 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" + } + ] + }, + "PrcgDt": { + "allOf": [ + { + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Dt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "Date\nSpecified date.\n" } ] } }, "required": [ - "OrgId" + "Dt" ] }, { "properties": { - "PrvtId": { + "DtTm": { "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" - } - ] + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "DateTime\nSpecified date and time.\n" + } + ] + } + }, + "required": [ + "DtTm" + ] + } + ], + "example": { + "DtTm": "2020-01-01T00:00:00Z" + } + }, + { + "description": "Date/time at which the instruction was processed by the specified party.\n" + } + ] + } + }, + "example": { + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" + }, + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" + } + } + }, + { + "description": "Information concerning the original transactions, to which the status report message refers.\n" + } + ] + }, + "SplmtryData": { + "allOf": [ + { + "title": "SupplementaryData1", + "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "CreationDateTime\nDate and time at which the message was created.\n" + } + ] + } + }, + "required": [ + "MsgId", + "CreDtTm" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z" + } + }, + { + "description": "Set of characteristics shared by all individual transactions included in the message.\n" + } + ] + }, + "TxInfAndSts": { + "allOf": [ + { + "title": "PaymentTransaction163", + "description": "Provides further details on the original transactions, to which the status report message refers.\n", + "type": "object", + "properties": { + "StsId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Unique identification, as assigned by the original sending party, to unambiguously identify the status report.\n" + } + ] + }, + "OrgnlInstrId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original instruction.\n\n(FSPIOP equivalent: transactionRequestId)\n" + } + ] + }, + "OrgnlEndToEndId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original end-to-end transaction.\n\n(FSPIOP equivalent: transactionId)\n" + } + ] + }, + "OrgnlTxId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original transaction.\n\n(FSPIOP equivalent: quoteId)\n" + } + ] + }, + "OrgnlUETR": { + "allOf": [ + { + "title": "UUIDv4Identifier", + "type": "string", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" + }, + { + "description": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n" + } + ] + }, + "TxSts": { + "allOf": [ + { + "title": "ExternalPaymentTransactionStatus1Code", + "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\",\n \"SETT\": \"SETTLED\"\n}\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": "SETT" + }, + { + "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 }, - "Othr": { - "allOf": [ - { - "title": "GenericPersonIdentification1", + { + "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": "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": "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": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "type": "object", - "anyOf": [ + { + "properties": { + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalPersonIdentification1Code", - "description": "Specifies the external person 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" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -73869,674 +102125,963 @@ "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": "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": [ + "Prtry" ] } - }, - "required": [ - "Id" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" + "Cd": "ADDR" } }, - { - "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 + "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": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\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": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", + "type": "object", + "anyOf": [ { - "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 + "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" + } + }, + { + "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": { + "OrgId": { + "AnyBIC": "BIC" }, - { - "description": "Identification\nIdentification assigned by an institution.\n" + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } - ] + } }, - "SchmeNm": { - "allOf": [ - { - "title": "AccountSchemeName1Choice", - "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "anyOf": [ + { + "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": { - "Cd": { + "ChanlTp": { "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": "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": "OtherContact\nContact details in another form.\n" } - ], - "example": { - "Cd": 1111 - } + ] }, - { - "description": "SchemeName\nName of the 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" + } }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "Contact Details\nSet of elements used to indicate how to contact the party.\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 + }, + "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" }, - { - "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 + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } }, - { - "description": "Proprietary\nNature or use of the account in a proprietary form.\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" } - ] + } + }, + { + "description": "Originator\nParty that issues the status.\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": { + }, + "Rsn": { "allOf": [ { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", "type": "object", "anyOf": [ { @@ -74544,15 +103089,15 @@ "Cd": { "allOf": [ { - "title": "ExternalProxyAccountType1Code", - "description": "Specifies the external proxy account type code.", + "title": "ExternalStatusReason1Code", + "description": "Specifies the external status reason 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\nReason for the status, as published in an external reason code list.\n" } ] } @@ -74574,7 +103119,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProxy account type, in a proprietary form.\n" + "description": "Proprietary\nReason for the status, in a proprietary form.\n" } ] } @@ -74585,436 +103130,384 @@ } ], "example": { - "Cd": "EMAIL" + "Cd": "AGNT" } }, { - "description": "Type\nType of the proxy identification.\n" + "description": "Reason\nSpecifies the reason for the status report.\n" } ] }, - "Id": { + "AddtlInf": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", "type": "string", "minLength": 1, - "maxLength": 2048, - "example": 2048 + "maxLength": 105, + "example": 12345 }, { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + "description": "AdditionalInformation\nAdditional information about the status report.\n" } ] } }, - "required": [ - "Id" - ], "example": { - "Tp": { - "Cd": "IBAN" + "Orgtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "SubDepartment", + "StrtNm": "StreetName", + "BldgNb": "BuildingNumber", + "PstCd": "PostCode", + "TwnNm": "TownName", + "CtrySubDvsn": "CountrySubDivision", + "Ctry": "Country" + } }, - "Id": 123 + "Rsn": { + "Cd": "AGNT" + }, + "AddtlInf": "AdditionalInformation" } }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "Information concerning the reason for the status.\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": { + "AccptncDtTm": { "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", - "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", + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "Date and time at which the status was accepted.\n" + } + ] + }, + "AcctSvcrRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" + } + ] + }, + "ExctnConf": { + "allOf": [ + { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string 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" + } + ] + }, + "PrcgDt": { + "allOf": [ + { + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Dt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "format": "date", + "example": "2013-03-07" }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + { + "description": "Date\nSpecified date.\n" + } + ] + } + }, + "required": [ + "Dt" + ] + }, + { + "properties": { + "DtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" }, - "CtrySubDvsn": { + { + "description": "DateTime\nSpecified date and time.\n" + } + ] + } + }, + "required": [ + "DtTm" + ] + } + ], + "example": { + "DtTm": "2020-01-01T00:00:00Z" + } + }, + { + "description": "Date/time at which the instruction was processed by the specified party.\n" + } + ] + } + }, + "example": { + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" + }, + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" + } + } + }, + { + "description": "Information concerning the original transactions, to which the status report message refers.\n" + } + ] + }, + "SplmtryData": { + "allOf": [ + { + "title": "SupplementaryData1", + "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "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", + "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": { + "Id": { + "allOf": [ + { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -75022,280 +103515,260 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\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 - }, - { - "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": [ + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "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": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation 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": "BIC" - } + ] }, - { - "description": "SchemeName\nName of the identification scheme.\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" + } + ] } - ] - }, - "Issr": { - "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": "Issuer\nEntity that assigns the identification.\n" + "properties": { + "Prtry": {} + } } - ] + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + ] + }, + "Issr": { + "allOf": [ + { + "title": "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": "BIC" - } - }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + { + "description": "Issuer\nEntity that assigns the identification.\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": [ + "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" } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" + ] } - ] + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "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": "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" + } + ] }, - { - "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" + "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" + } + ] }, - { - "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 + "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": "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": "PostalAddress24", - "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": "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": "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" - ], + "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" } ] } @@ -75309,67 +103782,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" } ] } @@ -75380,106 +103801,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", @@ -75487,1108 +103819,1177 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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\nFinancial institution servicing an account for a party.\n" + ] } + }, + "required": [ + "PrvtId" ] } - }, - "required": [ - "Pty" ], "example": { - "Pty": { - "Id": { - "OrgId": { - "AnyBIC": { - "BICFI": "BICFI" - } - } - }, - "CtryOfRes": "FI" - }, - "Acct": { - "Id": { - "IBAN": "FI2112345600000785" - } + "OrgId": { + "AnyBIC": "BIC" }, - "Agt": { - "FinInstnId": { - "BICFI": "BICFI" + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" } } } }, - "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", + "Party40Choice": { + "title": "Party40Choice", + "description": "Identification of a person, an organisation or a financial institution.\n", "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": { + "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\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 + "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": "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.", + "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": 4, - "example": 1234 + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "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": [ { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "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" + } + ] + } + }, + "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": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 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": { - "allOf": [ - { - "title": "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" }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } - ] - } - }, - "anyOf": [ - { - "properties": { - "Cd": {} } }, { - "properties": { - "Prtry": {} - } + "description": "Identification\nUnique and unambiguous way to identify an organisation.\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": [ - "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" - } - ] + "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" }, - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\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": "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" } - }, - "anyOf": [ + ] + }, + "CtctDtls": { + "allOf": [ { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", "properties": { - "Cd": {} + "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" } }, { - "properties": { - "Prtry": {} + "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": "BIC" } }, - { - "description": "SchemeName\nName of the 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" } - ] + } }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "Party\nIdentification of a person or an organisation.\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" - } + "required": [ + "Pty" ] - } - }, - "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", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "CreationDateTime\nDate and time at which the message was created.\n" - } - ] - } - }, - "required": [ - "MsgId", - "CreDtTm" - ], - "example": { - "MsgId": 12345, - "CreDtTm": "2020-01-01T00:00:00Z" - } - }, - { - "description": "Set of characteristics shared by all individual transactions included in the message.\n" - } - ] - }, - "TxInfAndSts": { - "allOf": [ - { - "title": "PaymentTransaction163", - "description": "Provides further details on the original transactions, to which the status report message refers.\n", - "type": "object", - "properties": { - "StsId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Unique identification, as assigned by the original sending party, to unambiguously identify the status report.\n" - } - ] - }, - "OrgnlInstrId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original instruction.\n\n(FSPIOP equivalent: transactionRequestId)\n" - } - ] - }, - "OrgnlEndToEndId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original end-to-end transaction.\n\n(FSPIOP equivalent: transactionId)\n" - } - ] - }, - "OrgnlTxId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original transaction.\n\n(FSPIOP equivalent: quoteId)\n" - } - ] - }, - "OrgnlUETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" - }, - { - "description": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n" - } - ] - }, - "TxSts": { - "allOf": [ - { - "title": "ExternalPaymentTransactionStatus1Code", - "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\",\n \"SETT\": \"SETTLED\"\n}\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": "SETT" - }, - { - "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" - } - ] + "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": "PostalAddress27", - "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", "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" - }, - { - "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" - } + "minLength": 1, + "maxLength": 5, + "example": 12345 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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" } ] } @@ -76599,122 +105000,17 @@ } ], "example": { - "Cd": "ADDR" + "Cd": "CHIPS" } }, - "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": "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", @@ -76722,824 +105018,964 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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", - "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": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } }, - "Id": { - "allOf": [ - { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\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", + "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { - "OrgId": { + "Cd": { "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": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "Code\nType of address expressed as a code.\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" - } + }, + "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": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "Othr": { + "Issr": { "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" - } + "title": "Max35Text", + "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": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, + "required": [ + "Id", + "Issr" + ], "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ - "PrvtId" + "Prtry" ] } ], "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } + "Cd": "ADDR" } }, - { - "description": "Identification\nUnique and unambiguous identification of a party.\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": "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" + "AdrLine": { + "title": "Max70Text", + "description": "Specifies 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": "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" - } - ] + { + "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": "OtherContact\nContact details in another form.\n" + "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" ] }, - "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" + { + "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": { - "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" + "Cd": "ADDR" } }, - { - "description": "Contact Details\nSet of elements used to indicate how to contact the 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 + }, + "SubDept": { + "title": "Max70Text", + "description": "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": [ - "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" - } + "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" } }, - "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": "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" } - } + ] }, - { - "description": "Originator\nParty that issues the status.\n" - } - ] - }, - "Rsn": { - "allOf": [ - { - "title": "StatusReason6Choice", - "description": "Specifies the reason for the status.\n", - "type": "object", - "anyOf": [ + "SchmeNm": { + "allOf": [ { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", "properties": { "Cd": { "allOf": [ { - "title": "ExternalStatusReason1Code", - "description": "Specifies the external status reason code.", + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { - "description": "Code\nReason for the status, as published in an external reason code list.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { + }, "Prtry": { "allOf": [ { @@ -77551,762 +105987,842 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nReason for the status, in a proprietary form.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, - "required": [ - "Prtry" - ] + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" } - ], - "example": { - "Cd": "AGNT" - } + ] }, - { - "description": "Reason\nSpecifies the reason for the status report.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\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 + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" }, - { - "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" + "Issr": "BIC" } }, - "Rsn": { - "Cd": "AGNT" - }, - "AddtlInf": "AdditionalInformation" - } - }, - { - "description": "Information concerning the reason for the status.\n" - } - ] - }, - "AccptncDtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "Date and time at which the status was accepted.\n" - } - ] - }, - "AcctSvcrRef": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" - } - ] - }, - "ClrSysRef": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\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" + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" } - ] + } }, - "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": "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" + } + ] }, - { - "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" + "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" + } + ] }, - { - "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" + "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": [ - "Envlp" - ], - "example": { - "PlcAndNm": "Additional information", - "Envlp": { - "Cd": "CH03", - "Prtry": "Additional information" + }, + "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": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" - } - ] - }, - "PrcgDt": { - "allOf": [ - { - "title": "StatusReason6Choice", - "description": "Specifies the reason for the status.\n", - "type": "object", - "anyOf": [ + "Othr": { + "allOf": [ { + "title": "GenericPersonIdentification2", + "type": "object", + "description": "Identification of a person.", "properties": { - "Dt": { + "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": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" + "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": "Date\nSpecified date.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] - } - }, - "required": [ - "Dt" - ] - }, - { - "properties": { - "DtTm": { + }, + "Issr": { "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", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "DateTime\nSpecified date and time.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "DtTm" - ] + "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": { - "DtTm": "2020-01-01T00:00:00Z" - } - }, - { - "description": "Date/time at which the instruction was processed by the specified party.\n" + ] } - ] - } - }, - "example": { - "StsId": 12345, - "OrgnlInstrId": 12345, - "OrgnlEndToEndId": 12345, - "OrgnlTxId": 12345, - "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", - "TxSts": "RJCT", - "StsRsnInf": { - "Rsn": "RSN", - "AddtlInf": "ADDITIONAL" - }, - "AccptncDtTm": "2020-01-01T00:00:00Z", - "AcctSvcrRef": "ACCTSVCRREF", - "ClrSysRef": "CLRSYSREF", - "ExctnConf": "1234567890ABCDEF", - "SplmtryData": { - "PlcAndNm": "PLACE", - "Envlp": "ENVELOPE" - } - } - }, - { - "description": "Information concerning the original transactions, to which the status report message refers.\n" - } - ] - }, - "SplmtryData": { - "allOf": [ - { - "title": "SupplementaryData1", - "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", - "type": "object", - "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 + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] + } }, - "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": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } - } - }, - { - "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" + ] } + }, + "required": [ + "PrvtId" ] } - }, - "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" - } - } + "OrgId": { + "AnyBIC": "BIC" }, - "TxInfAndSts": { - "OrgnlInstrId": 12345, - "OrgnlEndToEndId": 12345, - "TxSts": "RJCT", - "StsRsnInf": { - "Rsn": "RSN", - "AddtlInf": "ADDITIONAL" + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" } - }, - "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.", + "PartyIdentification135": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "properties": { - "GrpHdr": { + "Nm": { "allOf": [ { - "title": "GroupHeader120", - "description": "Set of characteristics shared by all individual transactions included in the message.\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": { - "MsgId": { - "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": "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" + "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" + } }, - "CreDtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "CreationDateTime\nDate and time at which the message was created.\n" - } - ] + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "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": [ - "MsgId", - "CreDtTm" - ], "example": { - "MsgId": 12345, - "CreDtTm": "2020-01-01T00:00:00Z" + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "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": "Set of characteristics shared by all individual transactions included in the message.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "TxInfAndSts": { + "Id": { "allOf": [ { - "title": "PaymentTransaction163", - "description": "Provides further details on the original transactions, to which the status report message refers.\n", + "title": "Party38Choice", + "description": "Nature or use of the account.\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.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\",\n \"SETT\": \"SETTLED\"\n}\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": "SETT" - }, - { - "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" - } - ] + "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" }, - "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": "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", - "description": "Choice of formats for the type of address.\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" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\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": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] - } - }, - "required": [ - "Cd" - ] + "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" - ] + "Prtry": {} + } } ], "example": { - "Cd": "ADDR" + "Cd": "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", + { + "description": "SchemeName\nName of the identification 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 }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 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": 140, - "example": 12345 + "format": "date", + "example": "2013-03-07" }, - "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + { + "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 }, - "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", @@ -78314,825 +106830,1157 @@ "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", - "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": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } }, - "Id": { - "allOf": [ - { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", - "type": "object", - "anyOf": [ + { + "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": [ { - "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" - ] + "title": "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": { - "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" - } - ] + "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" } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "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": "CUST", - "Prtry": 1 - } + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } - } - }, - { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "PrvtId" - ] + ], + "example": { + "Cd": "CCPT" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" } - ], - "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 }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + { + "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", + "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\nUnique and unambiguous identification of a party.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "CtryOfRes": { + "Issr": { "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": "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": "Issuer\nEntity that assigns the identification.\n" } ] }, - "CtctDtls": { + "SchmeNm": { "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" - } - ] + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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 }, - "MobNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + { + "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": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\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" + } + ] } - ] - }, - "FaxNb": { - "allOf": [ + }, + "anyOf": [ { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + "properties": { + "Cd": {} + } }, { - "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + "properties": { + "Prtry": {} + } } - ] + ], + "example": { + "Cd": "BIC" + } }, - "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" - } - ] + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "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" - } - ] + { + "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" }, - "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" - } - ] + { + "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 }, - "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" - } - ] + { + "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 }, - "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" - } - ] + { + "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" }, - "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": "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 }, - "Othr": { - "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": "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": "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" + "Prtry" + ] } - ] - } - }, - "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 + ], + "example": { + "Cd": "CCPT" + } }, { - "description": "Code\nReason for the status, as published in an external reason code list.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -79143,82 +107991,195 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nReason for the status, in a proprietary form.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Prtry" - ] + "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": { - "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 + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "AdditionalInformation\nAdditional information about the status report.\n" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] - } - }, - "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": "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": "Information concerning the reason for the status.\n" + "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, - "AccptncDtTm": { + "EmailAdr": { "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", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" + "minLength": 1, + "maxLength": 256, + "example": 256 }, { - "description": "Date and time at which the status was accepted.\n" + "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, - "AcctSvcrRef": { + "EmailPurp": { "allOf": [ { "title": "Max35Text", @@ -79229,11 +108190,11 @@ "example": 1.234567890123457e+34 }, { - "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" + "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, - "ClrSysRef": { + "JobTitl": { "allOf": [ { "title": "Max35Text", @@ -79244,555 +108205,409 @@ "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" + "description": "JobTitle\nTitle of the function.\n" } ] }, - "ExctnConf": { + "Rspnsblty": { "allOf": [ { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "example": "1234567890ABCDEF1234567890ABCDEF" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n" + "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, - "SplmtryData": { + "Dept": { "allOf": [ { - "title": "SupplementaryData1", - "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\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": "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": { - "PlcAndNm": { + "ChanlTp": { "allOf": [ { - "title": "Max350Text", - "description": "Specifies a character string with a maximum length of 350 characters.\n", + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, - "maxLength": 350, - "example": 350 + "maxLength": 4, + "example": 1234 }, { - "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "Envlp": { + "Id": { "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" + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 }, { - "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" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Envlp" - ], - "example": { - "PlcAndNm": "Additional information", - "Envlp": { - "Cd": "CH03", - "Prtry": "Additional information" - } - } - }, - { - "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" - } - ] - }, - "PrcgDt": { - "allOf": [ - { - "title": "StatusReason6Choice", - "description": "Specifies the reason for the status.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "Dt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "Date\nSpecified date.\n" - } - ] - } - }, - "required": [ - "Dt" - ] - }, - { - "properties": { - "DtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "DateTime\nSpecified date and time.\n" - } - ] - } - }, - "required": [ - "DtTm" - ] - } + "ChanlTp" ], "example": { - "DtTm": "2020-01-01T00:00:00Z" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "Date/time at which the instruction was processed by the specified party.\n" + "description": "OtherContact\nContact details in another form.\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": { + "PrefrdMtd": { "allOf": [ { - "title": "Max350Text", - "description": "Specifies a character string with a maximum length of 350 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": 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" + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" }, { - "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" + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, - "required": [ - "Envlp" - ], "example": { - "PlcAndNm": "Additional information", - "Envlp": { - "Cd": "CH03", - "Prtry": "Additional information" - } + "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": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ - "GrpHdr" + "Id" ], "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" + "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" } } }, - "Party38Choice": { - "title": "Party38Choice", - "description": "Nature or use of the account.\n", + "PaymentIdentification13": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\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" - } - ] - }, - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\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" - } - ] + "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 in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" } - }, - "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" - } - ] + "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.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\",\n \"SETT\": \"SETTLED\"\n}\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": "SETT" + }, + { + "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 }, - "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" - } - ] + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\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", + "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": "ExternalPersonIdentification1Code", - "description": "Specifies the external person identification code.", + "description": "AddressType2Code\nSpecifies the type 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" } ] } @@ -79806,15 +108621,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" } ] } @@ -79825,945 +108692,1580 @@ } ], "example": { - "Cd": "CCPT" + "Cd": "ADDR" } }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { + "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 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "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": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" + }, + "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" + } }, - "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": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\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", + "Id": { + "allOf": [ + { + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", "type": "object", - "description": "Choice of formats for the type of address.\n", "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": "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": "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": "PersonIdentification18", + "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": "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": "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": "Person\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 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" }, - "AdrLine": { - "title": "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": "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" } - }, - "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": [ + "CtctDtls": { + "allOf": [ { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", "properties": { - "OrgId": { + "NmPrfx": { "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" - } - ] - } - }, - "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": "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": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] - } - }, - "required": [ - "OrgId" - ] - }, - { - "properties": { - "PrvtId": { + }, + "Othr": { "allOf": [ { - "title": "PersonIdentification13", - "description": "Unique and unambiguous way to identify a person.\n", + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", "type": "object", "properties": { - "DtAndPlcOfBirth": { + "ChanlTp": { "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": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "Othr": { + "Id": { "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" - } + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 }, { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, + "required": [ + "ChanlTp" + ], "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\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": [ - "PrvtId" - ] - } - ], - "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "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" + } + }, + { + "description": "Information concerning the reason for the status.\n" + } + ] + }, + "AccptncDtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "Date and time at which the status was accepted.\n" + } + ] + }, + "AcctSvcrRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" + } + ] + }, + "ExctnConf": { + "allOf": [ + { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string 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" + } + ] + }, + "PrcgDt": { + "allOf": [ + { + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Dt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, { - "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" + "description": "Date\nSpecified date.\n" } ] - }, - "CtryOfRes": { + } + }, + "required": [ + "Dt" + ] + }, + { + "properties": { + "DtTm": { "allOf": [ { - "title": "CountryCode", + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, 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": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" }, { - "description": "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": "DateTime\nSpecified date and time.\n" } ] - }, - "CtctDtls": { + } + }, + "required": [ + "DtTm" + ] + } + ], + "example": { + "DtTm": "2020-01-01T00:00:00Z" + } + }, + { + "description": "Date/time at which the instruction was processed by the specified party.\n" + } + ] + } + }, + "example": { + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" + }, + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" + } + } + }, + "PaymentTypeInformation28": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "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": "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": { + "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" + } + } + }, + "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": "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": "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": "JobTitle\nTitle of the function.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, - "Rspnsblty": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -80774,1620 +110276,1794 @@ "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": "Proprietary\nName of the identification scheme, in a free text form.\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" + ] } - ] + ], + "example": { + "Cd": "CCPT" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\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" + ] + }, + "Issr": { + "allOf": [ + { + "title": "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": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Prtry": "DfspId" - } - } - } + { + "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" }, - "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": "BirthDate\nDate on which a person was born.\n" } - } + ] }, - { - "description": "Party\nIdentification of a person or an organisation.\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" } - }, - "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", - "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": { + "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": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated 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": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification 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\nName of the identification scheme, in a coded form as published in an external 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\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", + "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": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "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 }, - "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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 }, - "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" - } - ] + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 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 }, - "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": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "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": "SchemeName\nShort textual description of the scheme.\n" } - } + ] + } + }, + "required": [ + "Id", + "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" + "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] - }, - "BrnchId": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "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" - } - ] + "title": "Max35Text", + "description": "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nProxy account type, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nProxy account type, in a proprietary form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "EMAIL" + } + }, + "Purpose2Choice": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPurpose1Code", + "description": "Specifies the external purpose code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\n\nPurpose, in a proprietary form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "RegulatoryAuthority2": { + "title": "RegulatoryAuthority2", + "description": "Information about an entity requiring the regulatory reporting information.\n", + "type": "object", + "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})$" }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies 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": "Amount of 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" }, - "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" - } - ] + { + "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})$" + }, + { + "description": "Amount of 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": { - "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" - } + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under 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": "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": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } - ] - } + }, + { + "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\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" + "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" } - } + ] } }, - { - "description": "Agent\nIdentification of a financial institution.\n" + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 } - ] + }, + "type": "array" } - }, - "required": [ - "Agt" ] } - ], + }, "example": { - "Pty": { - "Nm": "Name", - "PstlAdr": { - "Ctry": "US", - "AdrLine": [ - "Line1", - "Line2" - ] - }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - } - } + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" }, - "Agt": { - "FinInstnId": { - "BICFI": "BUKBGB22" - }, - "BrnchId": { - "Id": 12345, - "Nm": "Oxford Street Branch", - "PstlAdr": { - "Ctry": "GB", - "AdrLine": [ - "1 Oxford Street", - "London", - "UK" - ] - } - } + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" } } }, - "Party52Choice": { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", + "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": { - "OrgId": { + "Cd": { "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" - } - } + "title": "ExternalServiceLevel1Code", + "description": "Specifies the external service level code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\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": [ - "OrgId" + "Cd" ] }, { "properties": { - "PrvtId": { + "Prtry": { "allOf": [ { - "title": "PersonIdentification18", - "description": "Unique and unambiguous way to identify 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": "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", - "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" - } - ] + "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": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "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": "BIC" - } - }, - { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + { + "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, + ], "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "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" + ] }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "Person\nUnique and unambiguous identification of a person, for example a passport.\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" } ] - } - }, - "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", + "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", - "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" - ], + "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": "ADDR" + "example": 1234 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } @@ -82401,67 +112077,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\nCategory purpose, in a proprietary form.\n" } ] } @@ -82472,106 +112096,119 @@ } ], "example": { - "Cd": "ADDR" + "Cd": "CASH" } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "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", + { + "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": 35, - "example": 1.234567890123457e+34 + "maxLength": 4, + "example": 1234 }, - "CtrySubDvsn": { + { + "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", @@ -82579,135 +112216,554 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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\nReason for the status, 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": "AGNT" + } + }, + "StatusReasonInformation14": { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Orgtr": { "allOf": [ { - "title": "Party38Choice", - "description": "Nature or use of the account.\n", + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", - "anyOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\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": { + "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": { - "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": "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" ] }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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" + { + "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" ] - }, - "Othr": { + } + ], + "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": "GenericOrganisationIdentification1", + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", - "description": "Information that locates and identifies an organisation.\n", "properties": { - "Id": { + "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": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" + "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, - "SchmeNm": { + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", "type": "object", "properties": { - "Cd": { + "BirthDt": { "allOf": [ { - "title": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification 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", + "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": 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": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, - "Prtry": { + "CityOfBirth": { "allOf": [ { "title": "Max35Text", @@ -82718,1492 +112774,1490 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "CityOfBirth\nCity where a person was born.\n" } ] - } - }, - "anyOf": [ - { - "properties": { - "Cd": {} - } }, - { - "properties": { - "Prtry": {} - } + "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": { - "Cd": "BIC" + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" } }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, - "Issr": { + "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": "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": "Issuer\nEntity that assigns the identification.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Id" - ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - "Issr": "BIC" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } } }, { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, - "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" + "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" + } + ] + } }, - "Issr": "BIC" + "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": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "Code\nReason for the status, as published in an external reason code 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", - "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 - } - } - } + "title": "Max35Text", + "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\nReason for the status, in a proprietary form.\n" } ] } }, "required": [ - "PrvtId" + "Prtry" ] } ], "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } + "Cd": "AGNT" } }, { - "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" + "description": "Reason\nSpecifies the reason for the status report.\n" } ] }, - "CtryOfRes": { + "AddtlInf": { "allOf": [ { - "title": "CountryCode", + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 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": 105, + "example": 12345 }, { - "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": "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" + } }, - "CtctDtls": { + "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": "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": { + "title": "Max35Text", + "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": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "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 - } + "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": "Other\nContact details in another 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" } ] }, - "PrefrdMtd": { + "Ccy": { "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": "ActiveOrHistoricCurrencyCode", "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "CELL" + "description": "A code allocated to a currency by a Maintenance Agency under 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": "PreferredMethod\nPreferred method used to reach the contact.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\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", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "type": "array" } ] } }, - "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" + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 }, - "Id": { - "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Prtry": "DfspId" - } + "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" } - } + ] }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "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" } } }, - "PartyIdentification272": { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "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": { - "Nm": { + "Rate": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "PercentageRate", "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "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": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, - "PstlAdr": { + "TaxblBaseAmt": { "allOf": [ { - "title": "PostalAddress27", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "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": { - "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" - ] - }, + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ { - "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" + "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" + } + ] }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under 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": { - "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" + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, - "Id": { + "TtlAmt": { "allOf": [ { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", + "title": "ActiveOrHistoricCurrencyAndAmount", "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" - } - ] + "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" } - }, - "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" - } - ] + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under 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" }, - "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" - } - ] + { + "description": "FromDate\nStart date of the range.\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" + "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" }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + { + "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" } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + ] + }, + "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" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } + { + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } - } + ] }, - { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\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": [ - "PrvtId" ] } + }, + "required": [ + "Amt" ], "example": { - "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" } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" } } }, { - "description": "Identification\nUnique and unambiguous identification of a party.\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 }, - "CtryOfRes": { + "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": "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": "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": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\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\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": { - "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": { + "TaxId": { "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 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}$" + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + "description": "TaxIdentification\n\nTax identification number of the creditor.\n" } ] }, - "MobNb": { + "RegnId": { "allOf": [ { - "title": "PhoneNumber", + "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": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, - "FaxNb": { + "TaxTp": { "allOf": [ { - "title": "PhoneNumber", + "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" + "description": "TaxType\n\nType of tax payer.\n" } ] - }, - "URLAdr": { + } + }, + "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": "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": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" + "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, - "EmailAdr": { + "RegnId": { "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": "EmailAddress\nAddress for electronic mail (e-mail).\n" + "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, - "EmailPurp": { + "TaxTp": { "allOf": [ { "title": "Max35Text", @@ -84214,11 +114268,82 @@ "example": 1.234567890123457e+34 }, { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + "description": "TaxType\n\nType of tax payer.\n" } ] }, - "JobTitl": { + "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", @@ -84229,11 +114354,11 @@ "example": 1.234567890123457e+34 }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, - "Rspnsblty": { + "RegnId": { "allOf": [ { "title": "Max35Text", @@ -84244,187 +114369,90 @@ "example": 1.234567890123457e+34 }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, - "Dept": { + "TaxTp": { "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 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "TaxType\n\nType of tax payer.\n" } ] }, - "Othr": { + "Authstn": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", "type": "object", "properties": { - "ChanlTp": { + "Titl": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a 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": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\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\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, - "required": [ - "ChanlTp" - ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Titl": "Mr", + "Nm": "John Doe" } }, { - "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": "Authorisation\n\nDetails of the authorised tax paying party.\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" + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } } }, { - "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" + "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n" } ] }, - "TxId": { + "AdmstnZone": { "allOf": [ { "title": "Max35Text", @@ -84435,71 +114463,26 @@ "example": 1.234567890123457e+34 }, { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" - } - ] - }, - "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" + "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\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": { + "RefNb": { "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": "Unique identification, as assigned by the original sending party, to unambiguously identify the status report.\n" + "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n" } ] }, - "OrgnlInstrId": { + "Mtd": { "allOf": [ { "title": "Max35Text", @@ -84510,1740 +114493,1891 @@ "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" + "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n" } ] }, - "OrgnlEndToEndId": { + "TtlTaxblBaseAmt": { "allOf": [ { - "title": "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": "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": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original end-to-end transaction.\n\n(FSPIOP equivalent: transactionId)\n" + "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" } ] }, - "OrgnlTxId": { + "TtlTaxAmt": { "allOf": [ { - "title": "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": "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": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original transaction.\n\n(FSPIOP equivalent: quoteId)\n" + "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" } ] }, - "OrgnlUETR": { + "Dt": { "allOf": [ { - "title": "UUIDv4Identifier", + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "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}$" + "format": "date", + "example": "2013-03-07" }, { - "description": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n" + "description": "Date\n\nDate by which tax is due.\n" } ] }, - "TxSts": { + "SeqNb": { "allOf": [ { - "title": "ExternalPaymentTransactionStatus1Code", - "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\",\n \"SETT\": \"SETTLED\"\n}\n", + "title": "Number", "type": "string", - "minLength": 1, - "maxLength": 4, - "example": "SETT" + "example": 256, + "pattern": "^(?!0\\d)\\d{1,18}$" }, { - "description": "Specifies the status of the transaction.\n" + "description": "SequenceNumber\n\nSequential number of the tax report.\n" } ] }, - "StsRsnInf": { - "allOf": [ + "Rcrd": { + "description": "Record\n\nDetails of the tax record.\n", + "anyOf": [ { - "title": "StatusReasonInformation14", - "description": "Unsure on description.\n", + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", "type": "object", "properties": { - "Orgtr": { + "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": "PartyIdentification272", - "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": "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": { - "Nm": { + "FrToDt": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" }, { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "PstlAdr": { + "Yr": { "allOf": [ { - "title": "PostalAddress27", + "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": "Information that locates and identifies a specific address, as defined by postal services.\n", + "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": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ + "ActiveOrHistoricCurrencyAndAmount": { + "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": "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": { - "Prtry": { + "FrToDt": { "allOf": [ { - "title": "GenericIdentification30", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", "type": "object", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { + "FrDt": { "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": "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": [ + "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" + } + } + }, + { + "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" + } + ] + } }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + { + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\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" + } } }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "ADDR" + { + "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" + } + ] } }, - "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": [ + "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" + } + ] + } }, - "AdrLine": { - "title": "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": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, - "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": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } - }, - { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\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" + } + ] + } }, - "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" - } - }, - { - "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" - } - ] - } + "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" + } + ] }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" + "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": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\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" + } + ] }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 + "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": "Person\nUnique and unambiguous identification of a person, for example a passport.\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" + } + ] }, - "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" - } - ] + "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" + } + ] + } }, - "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": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, - "required": [ - "ChanlTp" - ], - "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\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": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" } - ] + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } } }, - "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" - } - }, - { - "description": "Information concerning the reason for the status.\n" - } - ] - }, - "AccptncDtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "Date and time at which the status was accepted.\n" - } - ] - }, - "AcctSvcrRef": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" - } - ] - }, - "ClrSysRef": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" - } - ] - }, - "ExctnConf": { - "allOf": [ - { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string 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" - } - ] - }, - "PrcgDt": { - "allOf": [ - { - "title": "StatusReason6Choice", - "description": "Specifies the reason for the status.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "Dt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" + { + "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" + } + ] + } }, - { - "description": "Date\nSpecified date.\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" + } + ] }, - "required": [ - "Dt" - ] + "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" + } + ] + } }, - { - "properties": { - "DtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "DateTime\nSpecified date and time.\n" - } - ] + "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": [ - "DtTm" - ] + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 1000 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 200 + } + }, + "AddtlInf": "VAT applicable" } - ], - "example": { - "DtTm": "2020-01-01T00:00:00Z" - } - }, - { - "description": "Date/time at which the instruction was processed by the specified party.\n" + }, + "type": "array" } ] } }, "example": { - "StsId": 12345, - "OrgnlInstrId": 12345, - "OrgnlEndToEndId": 12345, - "OrgnlTxId": 12345, - "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", - "TxSts": "RJCT", - "StsRsnInf": { - "Rsn": "RSN", - "AddtlInf": "ADDITIONAL" + "Cdtr": { + "Titl": "Mr", + "Nm": "John Doe" }, - "AccptncDtTm": "2020-01-01T00:00:00Z", - "AcctSvcrRef": "ACCTSVCRREF", - "ClrSysRef": "CLRSYSREF", - "ExctnConf": "1234567890ABCDEF", - "SplmtryData": { - "PlcAndNm": "PLACE", - "Envlp": "ENVELOPE" + "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 } } }, - "PaymentTypeInformation28": { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", + "TaxParty1": { + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\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" - ] - } - ], - "example": { - "Cd": "SEPA" - } - }, - { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" - } - ] - }, - "LclInstrm": { + "TaxId": { "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" - } + "title": "Max35Text", + "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": "TaxIdentification\n\nTax identification number of the creditor.\n" } ] }, - "CtgyPurp": { + "RegnId": { "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] - } - }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" }, - "CtgyPurp": { - "Cd": "CASH" - } - } - }, - "PercentageRate": { - "title": "PercentageRate", - "type": "string", - "example": 1234, - "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" - }, - "PersonIdentification13": { - "title": "PersonIdentification13", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", - "properties": { - "DtAndPlcOfBirth": { + "TaxTp": { "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": "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" } ] }, - "Othr": { + "RegnId": { "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": "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", - "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { - "Id": { + "Titl": { "allOf": [ { "title": "Max35Text", @@ -86254,131 +116388,60 @@ "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" + "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\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\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, - "required": [ - "Id" - ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" + "Titl": "Mr", + "Nm": "John Doe" } }, { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" } ] } }, "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" } } }, - "PersonIdentification18": { - "title": "PersonIdentification18", - "description": "Unique and unambiguous way to identify a person.\n", + "TaxPeriod3": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", "type": "object", "properties": { - "DtAndPlcOfBirth": { + "FrToDt": { "allOf": [ { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", "type": "object", "properties": { - "BirthDt": { + "FrDt": { "allOf": [ { "title": "ISODate", @@ -86388,1145 +116451,1124 @@ "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": "FromDate\nStart date of the range.\n" } ] }, - "CtryOfBirth": { + "ToDt": { "allOf": [ { - "title": "CountryCode", + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation 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-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + "format": "date", + "example": "2013-03-07" }, { - "description": "CountryOfBirth\nCountry where a person was born.\n" + "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" + "FrDt", + "ToDt" ], "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, - "Othr": { + "Tp": { "allOf": [ { - "title": "GenericPersonIdentification2", + "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", - "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": { + "FrToDt": { "allOf": [ { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\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": [ - "Prtry" ] } + }, + "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": { - "Cd": "CCPT" - } + "example": "HLF1" }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "Issr": { + "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": "Issuer\nEntity that assigns the identification.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, - "required": [ - "Id" - ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } } }, { - "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", - "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" - } - ] + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 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": [ + "TaxAmt": { + "allOf": [ { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", "properties": { - "Cd": { + "Rate": { "allOf": [ { - "description": "AddressType2Code\nSpecifies 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": "PercentageRate", "type": "string", - "example": "ADDR" + "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": "Code\nType of address expressed as a code.\n" + "description": "Rate\n\nRate used to calculate the tax.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "TaxblBaseAmt": { "allOf": [ { - "title": "GenericIdentification30", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", - "description": "Generic scheme identification for a party.\n", + "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": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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": "Issuer\nEntity that assigns the identification.\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" } ] }, - "SchmeNm": { + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ - "Id", - "Issr" + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "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" + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "TtlAmt": { "allOf": [ { - "title": "GenericIdentification30", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", - "description": "Generic scheme identification for a party.\n", + "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": { - "Id": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\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" } ] }, - "Issr": { + "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": "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": "Issuer\nEntity that assigns the identification.\n" + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, - "SchmeNm": { + "Amt": { "allOf": [ { - "title": "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": "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ - "Id", - "Issr" + "Amt" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } } }, { - "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", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalProxyAccountType1Code", - "description": "Specifies the external proxy account type code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "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" + } + ] + } }, - { - "description": "Code\nProxy account type, in a coded form as published in an external list.\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" } - }, - "required": [ - "Cd" ] + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] - } + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 }, - "required": [ - "Prtry" - ] + "Inf": 12345 } - ], - "example": { - "Cd": "EMAIL" } }, { - "description": "Type\nType of the proxy identification.\n" + "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } ] }, - "Id": { + "Tp": { "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": "Type\n\nHigh level code to identify the type of tax details.\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 - }, - { - "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", - "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" - ] + "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" + } }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] - } + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 1000 }, - "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" - } - ] + "TtlAmt": { + "Ccy": "EUR", + "Amt": 200 + } }, - "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" + "AddtlInf": "VAT applicable" } }, - "RegulatoryReporting3": { - "title": "RegulatoryReporting3", - "description": "Information needed due to regulatory and/or statutory requirements.\n", + "TaxRecordDetails3": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", "type": "object", "properties": { - "DbtCdtRptgInd": { + "Prd": { "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" + "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": "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\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\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\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": [ + "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": "StructuredRegulatoryReporting3", - "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", + "title": "GroupHeader129", + "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", "properties": { - "Tp": { + "MsgId": { "allOf": [ { "title": "Max35Text", @@ -87537,447 +117579,409 @@ "example": 1.234567890123457e+34 }, { - "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" + "description": "Message Identification\n" } ] }, - "Dt": { + "CreDtTm": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. 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": "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": "date", - "example": "2013-03-07" + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" }, { - "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" + "description": "Creation Date and Time\n" } ] }, - "Ctry": { + "PmtInstrXpryDtTm": { "allOf": [ { - "title": "CountryCode", + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, 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": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" }, { - "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" + "description": "Payment Instruction Expiry Date and Time\n" } ] }, - "Cd": { + "NbOfTxs": { "allOf": [ { - "title": "Max10Text", - "description": "Specifies a character string with a maximum length of 10 characters.\n", + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", "type": "string", - "minLength": 1, - "maxLength": 10, - "example": 1234567890 + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 }, { - "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": "Number of Transactions\n" } ] }, - "Amt": { + "SttlmInf": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "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": "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", + "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", - "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})$" + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" }, - { - "description": "Amount of 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", + "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", - "description": "A code allocated to a currency by a Maintenance Agency under 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" + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "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" + ] + } + ], + "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": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "SttlmMtd" ], "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})$" - }, - { - "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" - } - ] + "SttlmMtd": "INDA", + "PmtTpInf": { + "InstrPrty": "NORM", + "SvcLvl": { + "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" + "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 + } } - }, - "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 + }, + { + "description": "Settlement Information\n" + } + ] } }, - "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": [ + "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" } - }, - "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": [ + "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": { - "Cd": { + "InstrId": { "allOf": [ { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level 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\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\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" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "EndToEndId": { "allOf": [ { "title": "Max35Text", @@ -87988,57 +117992,39 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" + "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" } ] - } - }, - "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": { + }, + "TxId": { "allOf": [ { - "title": "ExternalLocalInstrument1Code", - "description": "Specifies the external local instrument identification code.", + "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" + "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "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", @@ -88049,302 +118035,1170 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" + "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" } ] } }, "required": [ - "Prtry" - ] + "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" } - ], - "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": [ + "PmtTpInf": { + "allOf": [ { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", "properties": { - "Cd": { + "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": [ { - "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": "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": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "LclInstrm": { "allOf": [ { - "title": "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": "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": "Proprietary\nCategory purpose, in a proprietary form.\n" + "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\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 + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } }, { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" } ] }, - "PstlAdr": { + "UndrlygCstmrCdtTrf": { "allOf": [ { - "title": "PostalAddress27", + "title": "UnderlyingCustomerCreditTransfer", "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": [ + "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": { - "Cd": { + "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" + } + ] + }, + "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": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "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": [ { - "description": "AddressType2Code\nSpecifies 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": "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" + } + }, + { + "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": { + "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", - "example": "ADDR" + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { - "description": "Code\nType of address expressed as a 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" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "CtctDtls": { "allOf": [ { - "title": "GenericIdentification30", + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", "type": "object", - "description": "Generic scheme identification for a party.\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": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, - "Issr": { + "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", @@ -88355,11 +119209,11 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, - "SchmeNm": { + "JobTitl": { "allOf": [ { "title": "Max35Text", @@ -88370,2569 +119224,3256 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "JobTitle\nTitle of the function.\n" } ] - } - }, - "required": [ - "Id", - "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" + "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" + } + ] }, - { - "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" - } - ] + "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 }, - "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": "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 }, - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\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": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } - }, - "anyOf": [ + ] + }, + "Id": { + "allOf": [ { - "properties": { - "Cd": {} - } + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 }, { - "properties": { - "Prtry": {} - } + "description": "Identifier\nCommunication value such as phone number or email address.\n" } - ], - "example": { - "Cd": "BIC" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\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": "BIC" - }, - "Issr": "BIC" - } + ] }, - { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, 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": [ + "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" }, - "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" } } }, - { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\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" } - ] + } + }, + { + "description": "Party that owes an amount of money to the (ultimate) creditor.\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", + "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", - "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": "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" ] }, - "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": "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": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" ], "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" + "Cd": "ADDR" } }, - { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\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" + } }, - "Othr": { - "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": "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": { + "OrgId": { "allOf": [ { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "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": [ + { + "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": "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": "CCPT" + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "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": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" - } + "OrgId" + ] }, { - "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 + "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": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, - "Id": { + "CtryOfRes": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", + "title": "CountryCode", "type": "string", - "minLength": 1, - "maxLength": 128, - "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": "Identifier\nCommunication value such as phone number or email address.\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" } ] - } - }, - "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 + }, + "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": "Party to which an amount of money is due.\n" + } + ] }, - { - "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": { + "DbtrAgt": { "allOf": [ { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FrDt": { + "FinInstnId": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" + "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": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "FromDate\nStart date of the range.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "ToDt": { + "BrnchId": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: 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" - } - } - }, - { - "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" + "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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" + } + ] + } }, - { - "description": "ToDate\nEnd date of the range.\n" + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } - ] - } - }, - "required": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\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" - } - ] - }, - "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 + "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": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" + "description": "Financial institution servicing an account for the debtor.\n" } ] }, - "Nm": { - "allOf": [ - { - "title": "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": { + "CdtrAgt": { "allOf": [ { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FrDt": { + "FinInstnId": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" + "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": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "FromDate\nStart date of the range.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "ToDt": { + "BrnchId": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" + "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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": "ToDate\nEnd date of the range.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "FrDt", - "ToDt" + "FinInstnId" ], "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + "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": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" + "description": "Financial institution servicing an account for the creditor.\n" } ] - }, - "Tp": { + } + } + }, + { + "description": "Underlying Customer Credit Transfer\nTBD\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": "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": "ActiveCurrencyAndAmount_SimpleType", "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" + "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 } ] }, - "Yr": { + "Ccy": { "allOf": [ { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", + "title": "ActiveCurrencyCode", "type": "string", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 + "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": "Year\n\nYear related to the tax payment.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "ActiveCurrencyAndAmount": 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": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" } ] }, - "TaxAmt": { + "InstdAmt": { "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", - "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})$" + "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", - "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" - } + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under 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": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] - }, - "TtlAmt": { + } + }, + "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", @@ -90977,1024 +122518,1585 @@ } }, { - "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" } ] }, - "Dtls": { - "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", - "anyOf": [ + "Agt": { + "allOf": [ { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "Prd": { + "FinInstnId": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "FinancialInstitutionIdentification23", "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "FrToDt": { + "BICFI": { "allOf": [ { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\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": { - "FrDt": { + "ClrSysId": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" + "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": "FromDate\nStart date of the range.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "ToDt": { + "MmbId": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. 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": "ToDate\nEnd date of the range.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "FrDt", - "ToDt" + "MmbId" ], "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "Tp": { + "LEI": { "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": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a 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": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Type\n\nIdentification of the period related to the tax payment.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, - "Yr": { + "Nm": { "allOf": [ { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "description": "Year\n\nYear related to the tax payment.\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", + "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": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "Amt": { + "BrnchId": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "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 or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { - "ActiveOrHistoricCurrencyAndAmount": { + "Id": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "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})$" + "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": "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.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\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" + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies 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" + } + ] + } }, - { - "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" + "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": "ToDate\nEnd date of the range.\n" - } - ] + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" } }, - "required": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-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": "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" + "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": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] } }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } - ] - } - }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } + ] } }, - "type": "array" + "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" } ] - } - }, - "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" - } - ] + "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" + } + ] + } }, - "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": [ + "Cd" + ] }, - "required": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + { + "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": "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": { + "Cd": "CASH" } - ] - } - }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + }, + { + "description": "Type\nDefines the type of charges.\n" + } + ] } }, - { - "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" - } - ] + "required": [ + "Amt", + "Agt" + ], + "example": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" }, - "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})$" + "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": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\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": "Amount of 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" + "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": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" } }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "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": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\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" } - ] - }, - "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" - } - ] + }, + { + "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" + } + ] + } }, - "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": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" } }, - "required": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, 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" - } - ] - }, - "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" + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] + "Issr": "BIC" + } } }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\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", + "required": [ + "OrgId" + ] + }, + { "properties": { - "Prd": { + "PrvtId": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "properties": { - "FrToDt": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", "type": "object", "properties": { - "FrDt": { + "BirthDt": { "allOf": [ { "title": "ISODate", @@ -92004,2320 +124106,5150 @@ "example": "2013-03-07" }, { - "description": "FromDate\nStart date of the range.\n" + "description": "BirthDate\nDate on which a person was born.\n" } ] }, - "ToDt": { + "PrvcOfBirth": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. 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": "ToDate\nEnd date of the range.\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": [ - "FrDt", - "ToDt" + "BirthDt", + "CityOfBirth", + "CtryOfBirth" ], "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" } }, { - "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, - "Tp": { + "Othr": { "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" + "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": "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 + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } }, { - "description": "Year\n\nYear related to the tax payment.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } } }, { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "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 }, - "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" - } - ] + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } - }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + ] + }, + "PhneNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" + { + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } - } + ] }, - "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" + "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": "FromDate\nStart date of the range.\n" + "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" } ] }, - "ToDt": { + "DbtrAcct": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: 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": { + "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": "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" + } + ] + } + }, + "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": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FrDt": { + "FinInstnId": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" + "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": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "FromDate\nStart date of the range.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "ToDt": { + "BrnchId": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" + "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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": "ToDate\nEnd date of the range.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "FrDt", - "ToDt" + "FinInstnId" ], "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + "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": "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" + "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" } ] }, - "TaxblBaseAmt": { + "CdtrAgt": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "BranchAndFinancialInstitutionIdentification8", "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": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "ActiveOrHistoricCurrencyAndAmount": { + "FinInstnId": { "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})$" + "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": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "Amount of 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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "Ccy": { + "BrnchId": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under 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" + "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "FinInstnId" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "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": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, - "TtlAmt": { + "Cdtr": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\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": { + "Nm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "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})$" + "minLength": 1, + "maxLength": 140, + "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": "Name\nName by which a party is known and which is usually used to identify that 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": { + "PstlAdr": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "PostalAddress27", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "FrToDt": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", "properties": { - "FrDt": { + "Cd": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\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", - "format": "date", - "example": "2013-03-07" + "example": "ADDR" }, { - "description": "FromDate\nStart date of the range.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "ToDt": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" + "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": "ToDate\nEnd date of the range.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "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" - } - ] + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, - "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" - } - ] + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under 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": "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": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "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": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\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" - } - ] + "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" + } + ] + } }, - "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" + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" }, - { - "description": "ToDate\nEnd date of the range.\n" - } - ] + "Issr": "BIC" + } } }, - "required": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\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" - } - ] + "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": "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" + } + ] + } }, - "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" - } + "required": [ + "PrvtId" + ] } - }, - { - "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" - } - ] - } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } - }, - { - "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", - "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" - } - } - }, - "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", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "Creation Date and Time\n" - } - ] - }, - "PmtInstrXpryDtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "Payment Instruction Expiry Date and Time\n" - } - ] - }, - "NbOfTxs": { - "allOf": [ - { - "title": "Max15NumericText", - "description": "Specifies a numeric string with a maximum length of 15 digits.\n", - "type": "string", - "pattern": "^[0-9]{1,15}$", - "example": 123456789012345 - }, - { - "description": "Number of Transactions\n" - } - ] - }, - "SttlmInf": { - "allOf": [ - { - "title": "SettlementInstruction15", - "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", - "type": "object", - "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", + { + "description": "Identification\nUnique and unambiguous identification of a party.\n" + } + ] + }, + "CtryOfRes": { + "allOf": [ + { + "title": "CountryCode", "type": "string", - "enum": [ - "RTGS", - "RTNS", - "MPNS", - "BOOK" - ], - "example": "RTGS" + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, - "SvcLvl": { - "allOf": [ - { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", - "type": "object", - "anyOf": [ + { + "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": { - "Cd": { + "ChanlTp": { "allOf": [ { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level 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\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code 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\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } - }, - "required": [ - "Prtry" + }, + "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" + } ] } - ], - "example": { - "Cd": "SEPA" - } + }, + "required": [ + "Cd" + ] }, { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\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" + } }, - "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": [ + { + "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": [ { - "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" + "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": "Max35Text", - "description": "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": "Type\nType of the proxy identification.\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": [ + "Id": { + "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": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } - ], - "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": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } }, - "CtgyPurp": { - "Cd": "CASH" + { + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\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": { + "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 }, - "Id": { - "OrgId": { - "AnyBIC": "BIC", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN", - "Issr": "BIC" - } - } - } + { + "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 }, - "CtryOfRes": "CH", - "CtctDtls": { - "Nm": "Name", - "PhneNb": 123, - "EmailAdr": null + { + "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": "Settlement Information\n" + "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\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": { + }, + "InstrForNxtAgt": { "allOf": [ { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", + "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": { - "InstrId": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "enum": [ + "PHOA", + "TELA" + ], + "example": "PHOA" }, { - "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": "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" } ] }, - "EndToEndId": { + "InstrInf": { "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": "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": "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" ] - }, - "TxId": { + } + ], + "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": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "enum": [ + "CRED", + "DEBT", + "BOTH" + ], + "example": "BOTH" }, { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" + "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" } ] }, - "UETR": { + "Authrty": { "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}$" + "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": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + "description": "Authority\n\nEntity requiring the regulatory reporting information.\n" } ] }, - "ClrSysRef": { - "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": "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": "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 + } }, { - "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" + "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" + } + ] + } + }, + "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" } ] } }, - "required": [ - "TxId" - ], "example": { - "InstrId": "INSTRUCTIONID", - "EndToEndId": "ENDTOENDID", - "TxId": "TRANSACTIONID", - "UETR": "123e4567-e89b-12d3-a456-426614174000", - "ClrSysRef": "CLRSYSREF" + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + }, + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" + } } }, { - "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" + "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" } ] }, - "PmtTpInf": { + "Tax": { "allOf": [ { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", + "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": { - "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": { + "Cdtr": { "allOf": [ { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "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" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "SEPA" + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT" } }, { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" + "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" } ] }, - "LclInstrm": { + "Dbtr": { "allOf": [ { - "title": "LocalInstrument2Choice", + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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" + } + ] }, - { - "description": "Proprietary\nSpecifies the local instrument, as a proprietary 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\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" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "CH03" + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } } }, { - "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": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" } ] }, - "CtgyPurp": { + "UltmtDbtr": { "allOf": [ { - "title": "CategoryPurpose1Choice", - "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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" + } + ] }, - { - "description": "Proprietary\nCategory purpose, 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\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" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "CASH" + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } } }, { - "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" } ] - } - }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" }, - "LclInstrm": { - "Cd": "CORE" + "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" + } + ] }, - "CtgyPurp": { - "Cd": "CASH" - } - } - }, - { - "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" - } - ] - }, - "UndrlygCstmrCdtTrf": { - "allOf": [ - { - "title": "UnderlyingCustomerCreditTransfer", - "type": "object", - "properties": { - "InstdAmt": { + "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", @@ -94362,146 +129294,11 @@ } }, { - "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": "Underlying Customer Credit Transfer\nTBD\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": { + "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" + } + ] + }, + "TtlTaxAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", @@ -94546,2321 +129343,2497 @@ } }, { - "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" + "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" } ] }, - "Agt": { + "Dt": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: 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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FinInstnId": { + "AddtlInf": { "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": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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": { + "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": "GenericFinancialIdentification1", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\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": { + "FrDt": { "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 - }, - { - "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" - } + "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 agent, as assigned by an institution, 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" + } + ] + }, + "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": [], "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 + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" } } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, - "BrnchId": { + "TaxAmt": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", "type": "object", "properties": { - "Id": { + "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": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, - "LEI": { + "TaxblBaseAmt": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([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": "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": "LEI\nLegal entity identification for the branch of the financial institution.\n" + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, - "Nm": { + "TtlAmt": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "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": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" } ] }, - "PstlAdr": { - "allOf": [ + "Dtls": { + "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", + "anyOf": [ { - "title": "PostalAddress27", + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\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", - "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" - ] - }, + "Prd": { + "allOf": [ { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", "properties": { - "Prtry": { + "FrToDt": { "allOf": [ { - "title": "GenericIdentification30", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\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": { + "FrDt": { "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": "FromDate\nStart date of the range.\n" } ] }, - "SchmeNm": { + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ - "Id", - "Issr" + "FrDt", + "ToDt" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "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" + } + ] + } + }, + "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": [ - "Prtry" - ] + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\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 + ] } }, + "required": [ + "Amt" + ], "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", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalChargeType1Code", - "description": "Specifies the type of charge applied to the transaction.\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nCharge type, in a coded form.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification3", - "type": "object", - "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 + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } }, - { - "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n" + "Amt": { + "Amt": 100, + "Ccy": "EUR" } - ] + } }, - "Issr": { - "allOf": [ - { - "title": "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" + } + ] + } + }, + "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" + } + ] + } }, - { - "description": "Issuer\nEntity that assigns the identification.\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" } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "Issr": "BIC" - } + ] + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 }, - { - "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n" + "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": { - "Cd": "CASH" + "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" } }, { - "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": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] + "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" + } } }, - "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": "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" + } + ] + } }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\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" + } + ] + } }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length 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" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + { + "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\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" + ] + }, + "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", + "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" + } + ] + } }, - { - "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } } - ] - }, - "Othr": { - "allOf": [ - { - "title": "GenericOrganisationIdentification3", + }, + { + "items": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", "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": { + "Prd": { "allOf": [ { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", "type": "object", "properties": { - "Cd": { + "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": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification code.", + "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\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "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\nName of the identification scheme, in a free text form.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, - "anyOf": [ - { - "properties": { - "Cd": {} - } - }, - { - "properties": { - "Prtry": {} - } - } - ], "example": { - "Cd": "BIC" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } } }, { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "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" + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, - "SchmeNm": { + "Amt": { "allOf": [ { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", + "title": "ActiveOrHistoricCurrencyAndAmount", "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" - } - ] + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\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": [ - "Prtry" ] } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" ], "example": { - "Cd": "CCPT" + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ - "Id" + "Amt" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } }, - "Issr": "BIC" + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } } }, - { - "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 + "type": "array" } - } + ] } }, - { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\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" + } + ] }, - "required": [ - "PrvtId" - ] - } - ], - "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "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", + "anyOf": [ + { + "properties": { + "IlpV4PrepPacket": { + "allOf": [ + { + "title": "hexBinary", + "type": "string", + "example": 4660, + "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { - "description": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" } ] - }, - "CtryOfRes": { + } + }, + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "properties": { + "Sh256Sgntr": { "allOf": [ { - "title": "CountryCode", + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 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" + "example": "1234567890ABCDEF1234567890ABCDEF" }, { - "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": "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", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "Creation Date and Time\n" + } + ] + }, + "PmtInstrXpryDtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "Payment Instruction Expiry Date and Time\n" + } + ] + }, + "NbOfTxs": { + "allOf": [ + { + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", + "type": "string", + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 + }, + { + "description": "Number of Transactions\n" + } + ] + }, + "SttlmInf": { + "allOf": [ + { + "title": "SettlementInstruction15", + "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", + "type": "object", + "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" }, - "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": [ + "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": "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": "ExternalServiceLevel1Code", + "description": "Specifies the external service level 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\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code 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, + "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": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ - "ChanlTp" - ], - "example": { - "ChanlTp": "PHON", - "Id": 1234567890 - } + "Cd" + ] }, { - "description": "OtherContact\nContact details in another 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 the local instrument, as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "CH03" + } }, - "PrefrdMtd": { - "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": "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": { + "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" + ] }, { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\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": { - "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" - } + ] + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" }, - { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" } - ] + } } }, "required": [ - "Id" + "SttlmMtd" ], "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" + "SttlmMtd": "INDA", + "PmtTpInf": { + "InstrPrty": "NORM", + "SvcLvl": { + "Cd": "SEPA" }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "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 } } - }, - "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" + "description": "Settlement Information\n" } ] - }, - "DbtrAcct": { + } + }, + "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": "CashAccount40", + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", "type": "object", - "description": "Provides the details to identify an account.\n", "properties": { - "Id": { + "InstrId": { "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" - } + "title": "Max35Text", + "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 in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" + } + ] + }, + "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": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\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": [ - "Othr" + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": { - "IBAN": "BE71096123456769" + "Cd": "SEPA" } }, { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" + "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, - "Tp": { + "LclInstrm": { "allOf": [ { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", + "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": "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": "ExternalLocalInstrument1Code", + "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 35, + "example": 12345 }, { - "description": "Code\nAccount type, in a coded form.\n" + "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } @@ -96882,7 +131855,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } @@ -96893,303 +131866,156 @@ } ], "example": { - "Cd": "CACC" + "Cd": "CH03" } }, { - "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": "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" } ] }, - "Prxy": { + "CtgyPurp": { "allOf": [ { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "anyOf": [ + "anyOf": [ + { + "properties": { + "Cd": { + "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" - ] + "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": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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": "Code\nCategory purpose, as published in an external category purpose code list.\n" } - ], - "example": { - "Cd": "EMAIL" - } - }, - { - "description": "Type\nType of the proxy identification.\n" + ] } + }, + "required": [ + "Cd" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": [ - "Id" ], "example": { - "Tp": { - "Cd": "IBAN" - }, - "Id": 123 + "Cd": "CASH" } }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { - "Id": { - "IBAN": "BE71096123456769" + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" }, - "Tp": { - "Cd": "CACC" + "LclInstrm": { + "Cd": "CORE" }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 + "CtgyPurp": { + "Cd": "CASH" } } }, { - "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": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" } ] }, - "DbtrAgt": { + "UndrlygCstmrCdtTrf": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "UnderlyingCustomerCreditTransfer", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FinInstnId": { + "InstdAmt": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", - "description": "Information used to identify a financial institution.\n", + "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": { - "BICFI": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "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 - } + "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": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\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" } ] }, - "LEI": { + "Ccy": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated 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": "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 identifier of the financial institution.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] - }, + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Dbtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { "Nm": { "allOf": [ { @@ -97201,14 +132027,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": "PostalAddress24", + "title": "PostalAddress27", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -97323,6 +132149,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", @@ -97340,12 +132174,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", @@ -97356,12 +132190,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", @@ -97371,6 +132205,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", @@ -97396,28 +132238,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", @@ -97445,12 +132287,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", @@ -97463,640 +132307,565 @@ } }, { - "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" } ] }, - "Othr": { + "Id": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\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", - "anyOf": [ + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ { + "title": "OrganisationIdentification39", + "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" - ] - }, - { - "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\nName of the identification scheme, in a free text form.\n" + "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": [ - "Prtry" - ] + "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": { - "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": [ + "OrgId" ] - } - }, - "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": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" + { + "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" + } + ] }, - { - "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": "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" + } + ] }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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" - } - ] + "Issr": "BIC" + } }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum 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": "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" - } + ] + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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": "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": [ + "PrvtId" + ] } - }, + ], "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" + "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" } ] - } - }, - "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": { + }, + "CtryOfRes": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "title": "CountryCode", "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" + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\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" + "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" } ] }, - "ClrSysMmbId": { + "CtctDtls": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", "type": "object", "properties": { - "ClrSysId": { + "NmPrfx": { "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" - ] - } + "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": "CHIPS" - } + "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": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, - "MmbId": { + "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", @@ -98107,325 +132876,26 @@ "example": 1.234567890123457e+34 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "EmailPurpose\nPurpose for which an email address may be used.\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": [ + "JobTitl": { + "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": "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": "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": "JobTitle\nTitle of the function.\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": { + "Rspnsblty": { "allOf": [ { "title": "Max35Text", @@ -98436,176 +132906,163 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, - "SchmeNm": { + "Dept": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "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", - "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" - } - ] + "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": [], - "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" + "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" }, - "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": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, - "BrnchId": { + "Cdtr": { "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": [ { @@ -98617,7 +133074,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" } ] }, @@ -98874,473 +133331,844 @@ "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" + } + }, + { + "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", - "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" + "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" } ] - } - }, - "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": [ + }, + "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": { - "Cd": { + "NmPrfx": { "allOf": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\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": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" ], "type": "string", - "example": "ADDR" + "example": "DOCT" }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Nm": { "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": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\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 + }, + "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": { - "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" + "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": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Party to which an amount of money is due.\n" } ] }, - "Id": { + "DbtrAgt": { "allOf": [ { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "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" - } - ] + "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" }, - "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": [ + { + "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": [ { - "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": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 5, + "example": 12345 }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] - }, + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { "Prtry": { "allOf": [ { @@ -99352,233 +134180,148 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, - "anyOf": [ - { - "properties": { - "Cd": {} - } - }, - { - "properties": { - "Prtry": {} - } - } - ], - "example": { - "Cd": "BIC" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "CHIPS" + } }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\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" + "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" + } + ] } - ] - } - }, - "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" }, - "Issr": "BIC" + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + { + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } - } + ] }, - { - "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" - } - ] + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, - "Othr": { - "allOf": [ - { - "title": "GenericPersonIdentification2", + { + "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": "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" + "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": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "type": "object", - "anyOf": [ + { + "properties": { + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalPersonIdentification1Code", - "description": "Specifies the external person 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" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -99589,495 +134332,429 @@ "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": "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": [ + "Prtry" ] } - }, - "required": [ - "Id" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" + "Cd": "ADDR" } }, - { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\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": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 + }, + "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": "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 + "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": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "Othr": { + "BrnchId": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "properties": { - "ChanlTp": { + "Id": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a 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": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "Id": { + "LEI": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 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", + "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": 128, + "maxLength": 140, "example": 12345 }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\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", + "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": "Sets of elements to identify a name of the identification scheme.\n", + "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" } ] } @@ -100091,15 +134768,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" } ] } @@ -100110,192 +134839,122 @@ } ], "example": { - "Cd": 1111 + "Cd": "ADDR" } }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\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": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, - { - "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.", + "DstrctNm": { + "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" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -100303,774 +134962,1371 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Proprietary\nProxy account type, 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": "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", - "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": "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" + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } }, { - "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, + "required": [ + "FinInstnId" + ], "example": { - "Nm": "Swiss National Bank", - "Ctry": "CH" + "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": "Authority\n\nEntity requiring the regulatory reporting information.\n" + "description": "Financial institution servicing an account for the debtor.\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": [ + "CdtrAgt": { + "allOf": [ { - "title": "StructuredRegulatoryReporting3", - "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\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": { + "FinInstnId": { "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": "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": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "Amt": { + "BrnchId": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "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 or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { - "ActiveOrHistoricCurrencyAndAmount": { + "Id": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "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})$" + "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": "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.\n" + "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": 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": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } - }, - { - "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" + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, + "required": [ + "FinInstnId" + ], "example": { - "Tp": "T1", - "Dt": "2018-01-01", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Inf": 12345 + "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" + } + } } }, { - "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" - } - ] - } - }, - "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": "Financial institution servicing an account for the creditor.\n" + } + ] + } + } + }, + { + "description": "Underlying Customer Credit Transfer\nTBD\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": { - "DbtCdtRptgInd": "CRED", - "Authrty": { - "Nm": "Swiss National Bank", - "Ctry": "CH" + "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" + } + ] }, - "Dtls": { - "Cd": "A1", - "Inf": "Mandatory regulatory information" + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under 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": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" + "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" } ] }, - "Tax": { + "XchgRate": { "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": "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": { - "Cdtr": { + "Amt": { "allOf": [ { - "title": "TaxParty1", - "description": "Details about the entity involved in the tax paid or to be paid.\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": { - "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": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify 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" } ] }, - "TaxTp": { + "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": "TaxType\n\nType of tax payer.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], "example": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT" + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" + "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" } ] }, - "Dbtr": { + "Agt": { "allOf": [ { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "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": { + "FinInstnId": { "allOf": [ { - "title": "TaxAuthorisation1", - "description": "Details of an authorised tax paying party.\n", + "title": "FinancialInstitutionIdentification23", "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "Titl": { + "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": "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": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, @@ -101085,97 +136341,432 @@ "example": 12345 }, { - "description": "Name\n\nName of the debtor or the debtor's authorised representative.\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", + "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": { - "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 + "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": "TaxType\n\nType of tax payer.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "Authstn": { + "BrnchId": { "allOf": [ { - "title": "TaxAuthorisation1", - "description": "Details of an authorised tax paying party.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "properties": { - "Titl": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -101186,7 +136777,21 @@ "example": 1.234567890123457e+34 }, { - "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" + "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" } ] }, @@ -101201,2203 +136806,2936 @@ "example": 12345 }, { - "description": "Name\n\nName of the debtor or the debtor's authorised representative.\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" } ] } }, "example": { - "Titl": "Mr", - "Nm": "John Doe" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "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" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "FinInstnId" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "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": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" + "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" } ] }, - "TtlTaxAmt": { + "Tp": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "ChargeType3Choice", + "description": "ChargeType3Choice\nSpecifies the type of charge.\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", - "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" + "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" ] }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under 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": "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" ] } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Cd": "CASH" } }, { - "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" + "description": "Type\nDefines the type of charges.\n" } ] + } + }, + "required": [ + "Amt", + "Agt" + ], + "example": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" }, - "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" - } - ] + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } }, - "SeqNb": { + "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": "Number", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", - "example": 256, - "pattern": "^(?!0\\d)\\d{1,18}$" + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "description": "SequenceNumber\n\nSequential number of the tax report.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, - "Rcrd": { - "description": "Record\n\nDetails of the tax record.\n", - "anyOf": [ + "PstlAdr": { + "allOf": [ { - "title": "TaxRecord3", - "description": "Set of elements used to define the tax record.\n", + "title": "PostalAddress27", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "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": [ + "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": "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": { + "Prtry": { "allOf": [ { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", + "title": "GenericIdentification30", "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "FrDt": { + "Id": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. 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": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "format": "date", - "example": "2013-03-07" + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "FromDate\nStart date of the range.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "ToDt": { + "Issr": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. 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": "ToDate\nEnd date of the range.\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": [ - "FrDt", - "ToDt" + "Id", + "Issr" ], "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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": "Proprietary\nType of address expressed as a proprietary code.\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" + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "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" - } - ] + "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" }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under 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": "AnyBIC\nBusiness identification code of the organisation.\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" - } - ] + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under 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": "LEI\nLegal entity identification as an alternate identification for a party.\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" - } - ] + "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 }, - "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": "Code\nName of the identification scheme, in a coded form as published in an external list.\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" + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] } - ] - }, - "Tp": { - "allOf": [ + }, + "anyOf": [ { - "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" + "properties": { + "Cd": {} + } }, { - "description": "Type\n\nIdentification of the period related to the tax payment.\n" + "properties": { + "Prtry": {} + } } - ] + ], + "example": { + "Cd": "BIC" + } }, - "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": "SchemeName\nName of the identification scheme.\n" } - } + ] }, - { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "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" + } }, - "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" - } - ] + { + "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" }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under 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": "BirthDate\nDate on which a person was born.\n" } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + ] }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\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": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" } }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" + { + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\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" + "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" + } + ] } }, - { - "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 + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\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": "Year\n\nYear related to the tax payment.\n" - } - ] + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" } }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + { + "description": "SchemeName\nName of the identification scheme.\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" - } - ] - } + ] + }, + "Issr": { + "allOf": [ + { + "title": "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": "Issuer\nEntity that assigns the identification.\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": [ + "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" } - }, - "type": "array" + ] + } + }, + "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": { - "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 - } + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" + "description": "OtherContact\nContact details in another form.\n" } ] }, - "Tp": { + "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": "Type\n\nHigh level code to identify the type of tax details.\n" + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\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" + "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" } }, { - "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" - } - ] + "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" + } + ] + } }, - "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" + "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" + } + ] + } }, - { - "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" + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\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": "ToDate\nEnd date of the range.\n" - } - ] + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 } }, - "required": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + { + "description": "SchemeName\nName of the 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" - } - ] - }, - "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" - } - ] + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "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" } }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + { + "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } - }, - { - "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": [ + "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 }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + { + "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } - }, - { - "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": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "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\nProxy account type, in a proprietary form.\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" - } - ] - } + "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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + { + "description": "Code\nClearing system identification code, 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", - "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": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "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\nProprietary identification of the clearing system.\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" + ] + } + ], + "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" + } + ] } }, - { - "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" - } - ] + "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 }, - "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "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": "Issuer\nEntity that assigns the identification.\n" } - }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" } - } + ] + } + }, + "required": [ + "Id", + "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, - "Amt": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + "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", + "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" } }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - } - }, - "type": "array" - } - ] + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" } }, - "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 - } + "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": "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": { + "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" } - ] - } - }, - "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 + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } - }, - "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" + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } }, { - "description": "SHA-256 signature of the terms\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\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", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "Creation Date and Time\n" - } - ] - }, - "PmtInstrXpryDtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "Payment Instruction Expiry Date and Time\n" - } - ] - }, - "NbOfTxs": { - "allOf": [ - { - "title": "Max15NumericText", - "description": "Specifies a numeric string with a maximum length of 15 digits.\n", - "type": "string", - "pattern": "^[0-9]{1,15}$", - "example": 123456789012345 - }, - { - "description": "Number of Transactions\n" - } - ] - }, - "SttlmInf": { - "allOf": [ - { - "title": "SettlementInstruction15", - "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", - "type": "object", - "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" + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "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": [ + "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": { - "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", @@ -103408,57 +139746,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", - "anyOf": [ + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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", @@ -103469,56 +140075,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", - "anyOf": [ - { - "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", @@ -103529,412 +140151,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" - } - }, - { - "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", + }, + "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": "IBAN", - "Issr": "BIC" - } + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, - "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 in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n" - } - ] - }, - "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" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\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": { + "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", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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": 4, - "example": 1234 + "maxLength": 140, + "example": 12345 }, - { - "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", + "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 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.", + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, + "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", + "Flr": { + "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": "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, + "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", - "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": [ - { + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "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", @@ -103942,519 +140498,726 @@ "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 } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "CASH" - } - }, - { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" - } - ] - } - }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" - }, - "CtgyPurp": { - "Cd": "CASH" - } - } - }, - { - "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" - } - ] - }, - "UndrlygCstmrCdtTrf": { - "allOf": [ - { - "title": "UnderlyingCustomerCreditTransfer", - "type": "object", - "properties": { - "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" + }, + "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": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "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": "Underlying Customer Credit Transfer\nTBD\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" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\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", - "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" - } - ] + "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" - } - ] - }, - "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" + "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\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": "Amount of 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" - } + "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": "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": "PostalAddress27", "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", - "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 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation 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" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, - "required": [ - "Cd" - ] + "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 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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": "ProvinceOfBirth\nProvince 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" - } - ] - }, - "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 + "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": "MemberIdentification\nIdentification of a member of a clearing system.\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": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } }, - "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": "DateAndPlaceOfBirth\nDate and place of birth 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", + "Othr": { + "allOf": [ + { + "title": "GenericPersonIdentification2", "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" - } - ] + "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", @@ -104465,414 +141228,495 @@ "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" - } - ] - } - }, - "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" - } + "Prtry" ] } - }, - "required": [ - "Cd" - ] + ], + "example": { + "Cd": "CCPT" + } }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "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": "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 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "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": "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}$" }, - "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", + "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" } ] } @@ -104886,67 +141730,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" } ] } @@ -104957,122 +141749,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", @@ -105080,103 +141767,48 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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" - }, - "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" - } - } + "IBAN": "BE71096123456769" } }, { - "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" + "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { - "title": "ChargeType3Choice", - "description": "ChargeType3Choice\nSpecifies the type of charge.\n", + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", "type": "object", "anyOf": [ { @@ -105184,15 +141816,15 @@ "Cd": { "allOf": [ { - "title": "ExternalChargeType1Code", - "description": "Specifies the type of charge applied to the transaction.\n", + "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\nCharge type, in a coded form.\n" + "description": "Code\nAccount type, in a coded form.\n" } ] } @@ -105206,26 +141838,101 @@ "Prtry": { "allOf": [ { - "title": "GenericIdentification3", - "type": "object", - "description": "Generic scheme identification for a 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 + }, + { + "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": { - "Id": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 4, + "example": 1234 }, { - "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n" + "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] - }, - "Issr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -105236,924 +141943,1143 @@ "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, - "Issr": "BIC" - } - }, - { - "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n" + "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": [ - "Prtry" ] } + }, + "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": { - "Cd": "CASH" - } + "example": "PHOA" }, { - "description": "Type\nDefines the type of charges.\n" + "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" } ] } }, - "required": [ - "Amt", - "Agt" - ], "example": { - "Amt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - }, - "Agt": { - "BrnchId": { - "Id": "BRANCHID" + "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" + } + ] + } }, - "FinInstnId": { - "BICFI": "BICFI" - } + "required": [ + "Cd" + ] }, - "Tp": { - "Cd": "SHAR" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n" + "description": "Purpose\nUnderlying reason for the payment transaction.\n" } ] }, - "Dbtr": { + "RgltryRptg": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "RegulatoryReporting3", + "description": "Information needed due to regulatory and/or statutory requirements.\n", "type": "object", "properties": { - "Nm": { + "DbtCdtRptgInd": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "enum": [ + "CRED", + "DEBT", + "BOTH" + ], + "example": "BOTH" }, { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "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" } ] }, - "PstlAdr": { + "Authrty": { "allOf": [ { - "title": "PostalAddress27", + "title": "RegulatoryAuthority2", + "description": "Information about an entity requiring the regulatory reporting information.\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", - "anyOf": [ + "Nm": { + "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": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "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": "Name\n\nName of the entity requiring the regulatory reporting information.\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 + "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": { - "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" + "Nm": "Swiss National Bank", + "Ctry": "CH" } }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Authority\n\nEntity requiring the regulatory reporting information.\n" } ] }, - "Id": { - "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": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", + "title": "StructuredRegulatoryReporting3", + "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\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" - } - ] + "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})$" }, - "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": "Amount of 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": "Organisation\nUnique and unambiguous way to identify an organisation.\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" } - }, - "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": "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" - } - ] - } + "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})$" + }, + { + "description": "Amount of 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": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under 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": "Person\nUnique and unambiguous identification of a person, for example a passport.\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" + } + ] }, - "required": [ - "PrvtId" - ] + "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 } - ], - "example": { - "OrgId": { - "AnyBIC": "BIC" + }, + "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" + } + ] }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "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": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" } ] }, - "CtryOfRes": { + "Dbtr": { "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" + "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": "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": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" } ] }, - "CtctDtls": { + "UltmtDbtr": { "allOf": [ { - "title": "Contact13", - "description": "Specifies the details of the contact person.\n", + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "properties": { - "NmPrfx": { + "TaxId": { "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" - ], + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "example": "DOCT" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" + "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, - "Nm": { + "RegnId": { "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": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, - "PhneNb": { + "TaxTp": { "allOf": [ { - "title": "PhoneNumber", + "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": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + "description": "TaxType\n\nType of tax payer.\n" } ] }, - "MobNb": { + "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", + "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": "PhoneNumber", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + "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": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom 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" } ] }, - "FaxNb": { + "Ccy": { "allOf": [ { - "title": "PhoneNumber", + "title": "ActiveOrHistoricCurrencyCode", "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + "description": "A code allocated to a currency by a Maintenance Agency under 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": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] - }, - "URLAdr": { + } + }, + "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": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 2048, - "example": 2048 + "maxLength": 140, + "example": 12345 }, { - "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" + "description": "AdditionalInformation\n\nFurther details of the tax record.\n" } ] }, - "EmailAdr": { + "CertId": { "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": "EmailAddress\nAddress for electronic mail (e-mail).\n" + "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" } ] }, - "EmailPurp": { + "Ctgy": { "allOf": [ { "title": "Max35Text", @@ -106164,11 +143090,11 @@ "example": 1.234567890123457e+34 }, { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" } ] }, - "JobTitl": { + "CtgyDtls": { "allOf": [ { "title": "Max35Text", @@ -106179,11 +143105,11 @@ "example": 1.234567890123457e+34 }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" } ] }, - "Rspnsblty": { + "DbtrSts": { "allOf": [ { "title": "Max35Text", @@ -106194,3092 +143120,3273 @@ "example": 1.234567890123457e+34 }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" } ] }, - "Dept": { + "FrmsCd": { "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 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" } ] }, - "Othr": { + "Prd": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", "type": "object", "properties": { - "ChanlTp": { + "FrToDt": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", + "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", - "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": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "Id": { + "Yr": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", - "minLength": 1, - "maxLength": 128, - "example": 12345 + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, - "required": [ - "ChanlTp" - ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } } }, { - "description": "OtherContact\nContact details in another form.\n" + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, - "PrefrdMtd": { + "TaxAmt": { "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}$" + "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" + } + ] }, - { - "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 + "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" + } + ] }, - { - "description": "Identification\nIdentification assigned by an institution.\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" + } }, - "SchmeNm": { - "allOf": [ - { - "title": "AccountSchemeName1Choice", - "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "anyOf": [ + { + "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": { - "Cd": { + "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": "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": "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\nName of the identification scheme, in a coded form as published in an external list.\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": [ - "Cd" - ] + "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": { - "Prtry": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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": "Proprietary\nName of the identification scheme, in a free text 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" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under 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": [ - "Prtry" - ] + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\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 + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "Amt": { + "Amt": 100, + "Ccy": "EUR" } - ] - } - }, - "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" - } - ] - } - }, - "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", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", - "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "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": "Code\nClearing system identification code, as published in an external list.\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" + } + ] }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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" + } + ] + } }, - { - "description": "Proprietary\nProprietary identification of the clearing system.\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" } }, - "required": [ - "Prtry" - ] + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } } - ], - "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" + }, + "type": "array" } ] } }, - "required": [ - "MmbId" - ], "example": { - "ClrSysId": { - "Cd": "CHQB" + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 }, - "MmbId": 123456789 + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } } }, { - "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" + "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } ] }, - "Nm": { + "Tp": { "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": "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" + } }, - "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" - } - ] - } + "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" }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + { + "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": "Proprietary\nType of address expressed as a proprietary code.\n" - } - ] + ] + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "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", + "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" + } + ] } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "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": { + "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\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 - }, - { - "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": [ - { + ] + }, + "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" + } + ] + } + }, + "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" + } + } + }, + { + "items": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", "properties": { - "Cd": { + "Prd": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "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": "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" - ] - }, - { - "properties": { - "Prtry": { + }, + "Amt": { "allOf": [ { - "title": "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": "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": "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": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "BIC" + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + "type": "array" } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] + ] + } }, - "Issr": { - "allOf": [ - { - "title": "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": { + "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": "Issuer\nEntity that assigns the identification.\n" - } - ] + "Inf": 12345 + } } }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + { + "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 }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "TtlAmt": { + "Ccy": "EUR", + "Amt": 200 } - ] - } - }, - "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 + "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" } ] - }, - "BrnchId": { + } + }, + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "properties": { + "Sh256Sgntr": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "type": "object", + "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": [ + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + }, + "SeqTp": "SEQTP" + }, + "IntrBkSttlmAmt": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "InstdAmt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "XchgRate": 123.45, + "ChrgBr": "SHAR", + "ChrgsInf": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + }, + "Dbtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "CODE" + }, + "InstrForNxtAgt": { + "Cd": "CODE" + }, + "Purp": { + "Cd": "CASH" + }, + "RgltryRptg": { + "Dbtr": true, + "Cdtr": true + }, + "Tax": "Cdtr" + } + }, + { + "description": "Credit Transfer Transaction Information\nSet of elements providing information specific to the individual credit transfer(s).\n" + } + ] + } + }, + "required": [ + "GrpHdr", + "CdtTrfTxInf" + ], + "example": { + "GrpHdr": { + "MsgId": 123456789, + "CreDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "CtrlSum": 100, + "InitgPty": { + "Nm": "Initiating Party Name", + "Id": { + "OrgId": { + "Othr": [ + { + "Id": 123456789, + "SchmeNm": { + "Cd": "BBA", + "Prtry": "Party Identification Scheme Name" + } + } + ] + } + } + }, + "FwdgAgt": { + "FinInstnId": { + "BICFI": "BBBBBBBB" + } + } + } + } + }, + "UUIDv4Identifier": { + "title": "UUIDv4Identifier", + "type": "string", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" + }, + "UnderlyingCustomerCreditTransfer": { + "title": "UnderlyingCustomerCreditTransfer", + "type": "object", + "properties": { + "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" + } + ] + }, + "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": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": { + "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", - "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 + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "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" + } + ] }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 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" + } + ] }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] } }, + "required": [ + "Id", + "Issr" + ], "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": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" + ] } - ] + ], + "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": [ - "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" - } - } + "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": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "CdtrAgt": { + "Id": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\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": { + "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" + } + ] }, - { - "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" + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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" + } + } }, - "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": [ + { + "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": [ { - "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": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 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": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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": "BirthDate\nDate on which 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" - } - ] - }, - "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 + "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" + } + ] }, - { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\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": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } }, - "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": "DateAndPlaceOfBirth\nDate and place of birth 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", + "Othr": { + "allOf": [ + { + "title": "GenericPersonIdentification2", "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" - } - ] + "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": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } + "Cd" + ] }, { - "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" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "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": [ - "Cd" - ] + ], + "example": { + "Cd": "CCPT" + } }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "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": "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 + "maxLength": 4, + "example": 1234 }, { - "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\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": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 128, + "example": 12345 }, { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] - }, - "Nm": { + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + { + "description": "OtherContact\nContact details in another form.\n" + } + ] + }, + "PrefrdMtd": { + "allOf": [ + { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + }, + { + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + } + ] + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + }, + { + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + { + "description": "Party that owes an amount of money to the (ultimate) creditor.\n" + } + ] + }, + "Cdtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 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": 140, - "example": 12345 + "example": "ADDR" }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "PstlAdr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "PostalAddress27", + "title": "GenericIdentification30", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "description": "Generic scheme identification for a party.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ + "Id": { + "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": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\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" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] } }, + "required": [ + "Id", + "Issr" + ], "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": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\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": "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": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "Cdtr": { + "Id": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\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": { - "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" - } - } + "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": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] - } - }, - "required": [ - "OrgId" - ] - }, - { - "properties": { - "PrvtId": { + }, + "LEI": { "allOf": [ { - "title": "PersonIdentification18", - "description": "Unique and unambiguous way to identify a person.\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 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": { - "DtAndPlcOfBirth": { + "Id": { "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": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + "description": "Identification\nIdentification assigned by an institution.\n" } ] }, - "Othr": { + "SchmeNm": { "allOf": [ { - "title": "GenericPersonIdentification2", + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", "type": "object", - "description": "Identification of a person.", "properties": { - "Id": { + "Cd": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", "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" - } + "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", @@ -109290,458 +146397,215 @@ "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": "DRLC" - }, - "Issr": "BIC" + "Cd": "BIC" } }, { - "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": "BIC" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } + "Issr": "BIC" } }, { - "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" - } - ] + "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": [ - "ChanlTp" - ], - "example": { - "ChanlTp": "PHON", - "Id": 1234567890 - } - }, - { - "description": "OtherContact\nContact details in another form.\n" + "Issr": "BIC" } - ] + } }, - "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": "Organisation\nUnique and unambiguous way to identify an organisation.\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" - } - } + "required": [ + "OrgId" + ] }, - "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": { + "PrvtId": { + "allOf": [ { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", "properties": { - "IBAN": { + "DtAndPlcOfBirth": { "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}$" + "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": "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": "DateAndPlaceOfBirth\nDate and place of birth of a person.\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", + "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, @@ -109781,7 +146645,7 @@ } ], "example": { - "Cd": 1111 + "Cd": "CCPT" } }, { @@ -109811,2024 +146675,876 @@ "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" - } - ] - } - }, - "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" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\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" - } - ] - } - }, - "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 + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] - } - }, - "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" + } + }, + { + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + } + ] } + }, + "required": [ + "PrvtId" ] } - }, + ], "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" - } - ] + "OrgId": { + "AnyBIC": "BIC" }, - "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" - } - ] + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } - }, - "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" + "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, - "Purp": { + "CtryOfRes": { "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" - } + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { - "description": "Purpose\nUnderlying reason for the payment transaction.\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" } ] }, - "RgltryRptg": { + "CtctDtls": { "allOf": [ { - "title": "RegulatoryReporting3", - "description": "Information needed due to regulatory and/or statutory requirements.\n", + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", "type": "object", "properties": { - "DbtCdtRptgInd": { + "NmPrfx": { "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", + "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": [ - "CRED", - "DEBT", - "BOTH" + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" ], - "example": "BOTH" + "type": "string", + "example": "DOCT" }, { - "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": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, - "Authrty": { + "Nm": { "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" - } + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "description": "Authority\n\nEntity requiring the regulatory reporting information.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\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 - } - }, + "PhneNb": { + "allOf": [ { - "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" - } - ] - } - }, - "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" + "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" } ] - } - }, - "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": { + "MobNb": { "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": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { - "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, - "Dbtr": { + "FaxNb": { "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": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { - "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" + "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, - "UltmtDbtr": { + "URLAdr": { "allOf": [ { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\n", + "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": { - "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": { + "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 + "maxLength": 4, + "example": 1234 }, { - "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "TaxTp": { + "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 - }, - { - "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": 128, + "example": 12345 }, { - "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, + "required": [ + "ChanlTp" + ], "example": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT", - "Authstn": { - "Titl": "Mr", - "Nm": "John Doe" - } + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "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" + "description": "OtherContact\nContact details in another form.\n" } ] }, - "RefNb": { + "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": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n" + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] - }, - "Mtd": { + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + }, + { + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + { + "description": "Party to which an amount of money is due.\n" + } + ] + }, + "DbtrAgt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "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": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\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" } ] }, - "TtlTaxblBaseAmt": { + "ClrSysMmbId": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\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": { + "ClrSysId": { "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})$" + "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": "Amount of 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" } ] }, - "Ccy": { + "MmbId": { "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": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "MmbId" ], "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" - } - ] + "ClrSysId": { + "Cd": "CHQB" }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under 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" + "MmbId": 123456789 } }, { - "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "Dt": { + "LEI": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. 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": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", - "format": "date", - "example": "2013-03-07" + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Date\n\nDate by which tax is due.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, - "SeqNb": { + "Nm": { "allOf": [ { - "title": "Number", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", - "example": 256, - "pattern": "^(?!0\\d)\\d{1,18}$" + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "description": "SequenceNumber\n\nSequential number of the tax report.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, - "Rcrd": { - "description": "Record\n\nDetails of the tax record.\n", - "anyOf": [ + "PstlAdr": { + "allOf": [ { - "title": "TaxRecord3", - "description": "Set of elements used to define the tax record.\n", + "title": "PostalAddress24", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "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": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "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": { + "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", - "type": "string", + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" ], - "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" - } + "example": "ADDR" }, { - "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "Dtls": { - "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", - "anyOf": [ + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", + "title": "GenericIdentification30", "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Prd": { + "Id": { "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" - } - } + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "Amt": { + "Issr": { "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\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": [ - "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", - "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" - } - ] - } + "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 }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } - }, - "type": "array" + ] } + }, + "required": [ + "Cd" ] - } - }, - "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 + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } }, - "Inf": 12345 + "required": [ + "Prtry" + ] } + ], + "example": { + "Cd": "BIC" } }, { - "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "Tp": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -111839,1145 +147555,1393 @@ "example": 1.234567890123457e+34 }, { - "description": "Type\n\nHigh level code to identify the type of tax details.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, + "required": [ + "Id" + ], "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 - } + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - "AddtlInf": "VAT applicable" + "Issr": "BIC" } }, { - "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": "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" + } + ] } }, - { - "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": [ + "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": [ - "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" - } - ] - } + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum 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": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } - ] - }, - "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", - "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" - } - ] - } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Financial institution servicing an account for the debtor.\n" + } + ] + }, + "CdtrAgt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "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 }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } + { + "description": "Code\nClearing system identification code, as published in an external list.\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" - } - ] + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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 }, - "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" - } - ] + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } - }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" + { + "description": "SchemeName\nShort textual description of the scheme.\n" } - } - }, - "type": "array" + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } - ] - } - }, - "example": { - "Rate": 0, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 0 + }, + { + "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" + } + ] + } }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 0 + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } }, - "Dtls": { - "Tp": "T1", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 + "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", + "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" }, - "Inf": 12345 - } + { + "description": "Code\nType of address expressed as a code.\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 + "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": "Type\n\nHigh level code to identify the type of tax details.\n" - } - ] + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" } }, - "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" + "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 } }, - "type": "array" + "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": { - "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 + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" } } }, { - "description": "Tax\nProvides details on the tax.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\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": [ - "PmtId", - "IntrBkSttlmAmt", - "ChrgBr", - "Dbtr", - "DbtrAgt", - "CdtrAgt", - "Cdtr" + "FinInstnId" ], "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" - } + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Cdtr": { - "Nm": "NAME", + "BrnchId": { + "Id": 123, + "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", - "BldgNb": "BLDGNB", - "Ctry": "CTRY", - "TwnNm": "TWNNM", - "PstCd": "PSTCD", - "StrtNm": "STRTNM" - } - }, - "CdtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "InstrForCdtrAgt": { - "Cd": "CODE" - }, - "InstrForNxtAgt": { - "Cd": "CODE" - }, - "Purp": { - "Cd": "CASH" - }, - "RgltryRptg": { - "Dbtr": true, - "Cdtr": true - }, - "Tax": "Cdtr" - } - }, - { - "description": "Credit Transfer Transaction Information\nSet of elements providing information specific to the individual credit transfer(s).\n" - } - ] - } - }, - "required": [ - "GrpHdr", - "CdtTrfTxInf" - ], - "example": { - "GrpHdr": { - "MsgId": 123456789, - "CreDtTm": "2020-01-01T00:00:00Z", - "NbOfTxs": 1, - "CtrlSum": 100, - "InitgPty": { - "Nm": "Initiating Party Name", - "Id": { - "OrgId": { - "Othr": [ - { - "Id": 123456789, - "SchmeNm": { - "Cd": "BBA", - "Prtry": "Party Identification Scheme Name" - } + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" } - ] - } - } - }, - "FwdgAgt": { - "FinInstnId": { - "BICFI": "BBBBBBBB" - } - } - } - } - }, - "UUIDv4Identifier": { - "title": "UUIDv4Identifier", - "type": "string", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" - }, - "UnderlyingCustomerCreditTransfer": { - "title": "UnderlyingCustomerCreditTransfer", - "type": "object", - "properties": { - "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" + "description": "Financial institution servicing an account for the creditor.\n" } ] } diff --git a/src/fspiop/v2_0_ISO20022/openapi.ts b/src/fspiop/v2_0_ISO20022/openapi.ts index b95f32c3..60d81605 100644 --- a/src/fspiop/v2_0_ISO20022/openapi.ts +++ b/src/fspiop/v2_0_ISO20022/openapi.ts @@ -3760,6 +3760,10 @@ export interface components { /** UnderlyingCustomerCreditTransfer */ UnderlyingCustomerCreditTransfer: { InstdAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"] & unknown; + Dbtr?: components["schemas"]["PartyIdentification272"] & unknown; + Cdtr?: components["schemas"]["PartyIdentification272"] & unknown; + DbtrAgt?: components["schemas"]["BranchAndFinancialInstitutionIdentification8"] & unknown; + CdtrAgt?: components["schemas"]["BranchAndFinancialInstitutionIdentification8"] & unknown; }; /** * VerificationReason1Choice From 5ea02b3c947937c54429270d144e2a7d5c770f5b Mon Sep 17 00:00:00 2001 From: Kevin Leyow Date: Thu, 10 Oct 2024 09:27:08 -0500 Subject: [PATCH 08/10] chore: dep --- package-lock.json | 220 +++++++++++++++++++++++----------------------- package.json | 8 +- 2 files changed, 115 insertions(+), 113 deletions(-) diff --git a/package-lock.json b/package-lock.json index 660c9f4d..4be68797 100644 --- a/package-lock.json +++ b/package-lock.json @@ -26,8 +26,8 @@ "@redocly/openapi-cli": "^1.0.0-beta.95", "@types/jest": "^29.5.13", "@types/js-yaml": "^4.0.9", - "@typescript-eslint/eslint-plugin": "^8.8.0", - "@typescript-eslint/parser": "^8.8.0", + "@typescript-eslint/eslint-plugin": "^8.8.1", + "@typescript-eslint/parser": "^8.8.1", "audit-ci": "^7.1.0", "browser-sync": "^3.0.3", "diff": "^7.0.0", @@ -36,7 +36,7 @@ "eslint-config-standard": "^17.1.0", "eslint-import-resolver-typescript": "^3.6.3", "eslint-plugin-cucumber": "^2.0.0", - "eslint-plugin-import": "^2.30.0", + "eslint-plugin-import": "^2.31.0", "eslint-plugin-node": "^11.1.0", "eslint-plugin-prettier": "^5.2.1", "eslint-plugin-promise": "^6.2.0", @@ -53,7 +53,7 @@ "ts-node": "^10.9.2", "ts-patch": "^3.2.1", "tslib": "^2.7.0", - "typescript": "^5.6.2" + "typescript": "^5.6.3" } }, "node_modules/@aashutoshrathi/word-wrap": { @@ -2679,16 +2679,16 @@ "dev": true }, "node_modules/@typescript-eslint/eslint-plugin": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.8.0.tgz", - "integrity": "sha512-wORFWjU30B2WJ/aXBfOm1LX9v9nyt9D3jsSOxC3cCaTQGCW5k4jNpmjFv3U7p/7s4yvdjHzwtv2Sd2dOyhjS0A==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.8.1.tgz", + "integrity": "sha512-xfvdgA8AP/vxHgtgU310+WBnLB4uJQ9XdyP17RebG26rLtDrQJV3ZYrcopX91GrHmMoH8bdSwMRh2a//TiJ1jQ==", "dev": true, "dependencies": { "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "8.8.0", - "@typescript-eslint/type-utils": "8.8.0", - "@typescript-eslint/utils": "8.8.0", - "@typescript-eslint/visitor-keys": "8.8.0", + "@typescript-eslint/scope-manager": "8.8.1", + "@typescript-eslint/type-utils": "8.8.1", + "@typescript-eslint/utils": "8.8.1", + "@typescript-eslint/visitor-keys": "8.8.1", "graphemer": "^1.4.0", "ignore": "^5.3.1", "natural-compare": "^1.4.0", @@ -2712,15 +2712,15 @@ } }, "node_modules/@typescript-eslint/parser": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.8.0.tgz", - "integrity": "sha512-uEFUsgR+tl8GmzmLjRqz+VrDv4eoaMqMXW7ruXfgThaAShO9JTciKpEsB+TvnfFfbg5IpujgMXVV36gOJRLtZg==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.8.1.tgz", + "integrity": "sha512-hQUVn2Lij2NAxVFEdvIGxT9gP1tq2yM83m+by3whWFsWC+1y8pxxxHUFE1UqDu2VsGi2i6RLcv4QvouM84U+ow==", "dev": true, "dependencies": { - "@typescript-eslint/scope-manager": "8.8.0", - "@typescript-eslint/types": "8.8.0", - "@typescript-eslint/typescript-estree": "8.8.0", - "@typescript-eslint/visitor-keys": "8.8.0", + "@typescript-eslint/scope-manager": "8.8.1", + "@typescript-eslint/types": "8.8.1", + "@typescript-eslint/typescript-estree": "8.8.1", + "@typescript-eslint/visitor-keys": "8.8.1", "debug": "^4.3.4" }, "engines": { @@ -2740,13 +2740,13 @@ } }, "node_modules/@typescript-eslint/scope-manager": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.8.0.tgz", - "integrity": "sha512-EL8eaGC6gx3jDd8GwEFEV091210U97J0jeEHrAYvIYosmEGet4wJ+g0SYmLu+oRiAwbSA5AVrt6DxLHfdd+bUg==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.8.1.tgz", + "integrity": "sha512-X4JdU+66Mazev/J0gfXlcC/dV6JI37h+93W9BRYXrSn0hrE64IoWgVkO9MSJgEzoWkxONgaQpICWg8vAN74wlA==", "dev": true, "dependencies": { - "@typescript-eslint/types": "8.8.0", - "@typescript-eslint/visitor-keys": "8.8.0" + "@typescript-eslint/types": "8.8.1", + "@typescript-eslint/visitor-keys": "8.8.1" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -2757,13 +2757,13 @@ } }, "node_modules/@typescript-eslint/type-utils": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.8.0.tgz", - "integrity": "sha512-IKwJSS7bCqyCeG4NVGxnOP6lLT9Okc3Zj8hLO96bpMkJab+10HIfJbMouLrlpyOr3yrQ1cA413YPFiGd1mW9/Q==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.8.1.tgz", + "integrity": "sha512-qSVnpcbLP8CALORf0za+vjLYj1Wp8HSoiI8zYU5tHxRVj30702Z1Yw4cLwfNKhTPWp5+P+k1pjmD5Zd1nhxiZA==", "dev": true, "dependencies": { - "@typescript-eslint/typescript-estree": "8.8.0", - "@typescript-eslint/utils": "8.8.0", + "@typescript-eslint/typescript-estree": "8.8.1", + "@typescript-eslint/utils": "8.8.1", "debug": "^4.3.4", "ts-api-utils": "^1.3.0" }, @@ -2781,9 +2781,9 @@ } }, "node_modules/@typescript-eslint/types": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.8.0.tgz", - "integrity": "sha512-QJwc50hRCgBd/k12sTykOJbESe1RrzmX6COk8Y525C9l7oweZ+1lw9JiU56im7Amm8swlz00DRIlxMYLizr2Vw==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.8.1.tgz", + "integrity": "sha512-WCcTP4SDXzMd23N27u66zTKMuEevH4uzU8C9jf0RO4E04yVHgQgW+r+TeVTNnO1KIfrL8ebgVVYYMMO3+jC55Q==", "dev": true, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -2794,13 +2794,13 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.8.0.tgz", - "integrity": "sha512-ZaMJwc/0ckLz5DaAZ+pNLmHv8AMVGtfWxZe/x2JVEkD5LnmhWiQMMcYT7IY7gkdJuzJ9P14fRy28lUrlDSWYdw==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.8.1.tgz", + "integrity": "sha512-A5d1R9p+X+1js4JogdNilDuuq+EHZdsH9MjTVxXOdVFfTJXunKJR/v+fNNyO4TnoOn5HqobzfRlc70NC6HTcdg==", "dev": true, "dependencies": { - "@typescript-eslint/types": "8.8.0", - "@typescript-eslint/visitor-keys": "8.8.0", + "@typescript-eslint/types": "8.8.1", + "@typescript-eslint/visitor-keys": "8.8.1", "debug": "^4.3.4", "fast-glob": "^3.3.2", "is-glob": "^4.0.3", @@ -2846,15 +2846,15 @@ } }, "node_modules/@typescript-eslint/utils": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.8.0.tgz", - "integrity": "sha512-QE2MgfOTem00qrlPgyByaCHay9yb1+9BjnMFnSFkUKQfu7adBXDTnCAivURnuPPAG/qiB+kzKkZKmKfaMT0zVg==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.8.1.tgz", + "integrity": "sha512-/QkNJDbV0bdL7H7d0/y0qBbV2HTtf0TIyjSDTvvmQEzeVx8jEImEbLuOA4EsvE8gIgqMitns0ifb5uQhMj8d9w==", "dev": true, "dependencies": { "@eslint-community/eslint-utils": "^4.4.0", - "@typescript-eslint/scope-manager": "8.8.0", - "@typescript-eslint/types": "8.8.0", - "@typescript-eslint/typescript-estree": "8.8.0" + "@typescript-eslint/scope-manager": "8.8.1", + "@typescript-eslint/types": "8.8.1", + "@typescript-eslint/typescript-estree": "8.8.1" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -2868,12 +2868,12 @@ } }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.8.0.tgz", - "integrity": "sha512-8mq51Lx6Hpmd7HnA2fcHQo3YgfX1qbccxQOgZcb4tvasu//zXRaA1j5ZRFeCw/VRAdFi4mRM9DnZw0Nu0Q2d1g==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.8.1.tgz", + "integrity": "sha512-0/TdC3aeRAsW7MDvYRwEc1Uwm0TIBfzjPFgg60UU2Haj5qsCs9cc3zNgY71edqE3LbWfF/WoZQd3lJoDXFQpag==", "dev": true, "dependencies": { - "@typescript-eslint/types": "8.8.0", + "@typescript-eslint/types": "8.8.1", "eslint-visitor-keys": "^3.4.3" }, "engines": { @@ -5419,9 +5419,9 @@ } }, "node_modules/eslint-module-utils": { - "version": "2.10.0", - "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.10.0.tgz", - "integrity": "sha512-/AXiipjFyfLIUj3E4FR5NEGWoGDZHDfcGzWZkwobRc8fwqUAcy9owTk2LIKwNmtYL8Ad9/XfjSXbGHZ9AJWDEg==", + "version": "2.12.0", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.12.0.tgz", + "integrity": "sha512-wALZ0HFoytlyh/1+4wuZ9FJCD/leWHQzzrxJ8+rebyReSLk7LApMyd3WJaLVoN+D5+WIdJyDK1c6JnE65V4Zyg==", "dev": true, "dependencies": { "debug": "^3.2.7" @@ -5503,9 +5503,9 @@ } }, "node_modules/eslint-plugin-import": { - "version": "2.30.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.30.0.tgz", - "integrity": "sha512-/mHNE9jINJfiD2EKkg1BKyPyUk4zdnT54YgbOgfjSakWT5oyX/qQLVNTkehyfpcMxZXMy1zyonZ2v7hZTX43Yw==", + "version": "2.31.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.31.0.tgz", + "integrity": "sha512-ixmkI62Rbc2/w8Vfxyh1jQRTdRTF52VxwRVHl/ykPAmqG+Nb7/kNn+byLP0LxPgI7zWA16Jt82SybJInmMia3A==", "dev": true, "dependencies": { "@rtsao/scc": "^1.1.0", @@ -5516,7 +5516,7 @@ "debug": "^3.2.7", "doctrine": "^2.1.0", "eslint-import-resolver-node": "^0.3.9", - "eslint-module-utils": "^2.9.0", + "eslint-module-utils": "^2.12.0", "hasown": "^2.0.2", "is-core-module": "^2.15.1", "is-glob": "^4.0.3", @@ -5525,13 +5525,14 @@ "object.groupby": "^1.0.3", "object.values": "^1.2.0", "semver": "^6.3.1", + "string.prototype.trimend": "^1.0.8", "tsconfig-paths": "^3.15.0" }, "engines": { "node": ">=4" }, "peerDependencies": { - "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8" + "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8 || ^9" } }, "node_modules/eslint-plugin-import/node_modules/debug": { @@ -12562,9 +12563,9 @@ "dev": true }, "node_modules/typescript": { - "version": "5.6.2", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.2.tgz", - "integrity": "sha512-NW8ByodCSNCwZeghjN3o+JX5OFH0Ojg6sadjEKY4huZ52TqbJTJnDo5+Tw98lSy63NZvi4n+ez5m2u5d4PkZyw==", + "version": "5.6.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.3.tgz", + "integrity": "sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==", "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -15150,16 +15151,16 @@ "dev": true }, "@typescript-eslint/eslint-plugin": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.8.0.tgz", - "integrity": "sha512-wORFWjU30B2WJ/aXBfOm1LX9v9nyt9D3jsSOxC3cCaTQGCW5k4jNpmjFv3U7p/7s4yvdjHzwtv2Sd2dOyhjS0A==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.8.1.tgz", + "integrity": "sha512-xfvdgA8AP/vxHgtgU310+WBnLB4uJQ9XdyP17RebG26rLtDrQJV3ZYrcopX91GrHmMoH8bdSwMRh2a//TiJ1jQ==", "dev": true, "requires": { "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "8.8.0", - "@typescript-eslint/type-utils": "8.8.0", - "@typescript-eslint/utils": "8.8.0", - "@typescript-eslint/visitor-keys": "8.8.0", + "@typescript-eslint/scope-manager": "8.8.1", + "@typescript-eslint/type-utils": "8.8.1", + "@typescript-eslint/utils": "8.8.1", + "@typescript-eslint/visitor-keys": "8.8.1", "graphemer": "^1.4.0", "ignore": "^5.3.1", "natural-compare": "^1.4.0", @@ -15167,54 +15168,54 @@ } }, "@typescript-eslint/parser": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.8.0.tgz", - "integrity": "sha512-uEFUsgR+tl8GmzmLjRqz+VrDv4eoaMqMXW7ruXfgThaAShO9JTciKpEsB+TvnfFfbg5IpujgMXVV36gOJRLtZg==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.8.1.tgz", + "integrity": "sha512-hQUVn2Lij2NAxVFEdvIGxT9gP1tq2yM83m+by3whWFsWC+1y8pxxxHUFE1UqDu2VsGi2i6RLcv4QvouM84U+ow==", "dev": true, "requires": { - "@typescript-eslint/scope-manager": "8.8.0", - "@typescript-eslint/types": "8.8.0", - "@typescript-eslint/typescript-estree": "8.8.0", - "@typescript-eslint/visitor-keys": "8.8.0", + "@typescript-eslint/scope-manager": "8.8.1", + "@typescript-eslint/types": "8.8.1", + "@typescript-eslint/typescript-estree": "8.8.1", + "@typescript-eslint/visitor-keys": "8.8.1", "debug": "^4.3.4" } }, "@typescript-eslint/scope-manager": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.8.0.tgz", - "integrity": "sha512-EL8eaGC6gx3jDd8GwEFEV091210U97J0jeEHrAYvIYosmEGet4wJ+g0SYmLu+oRiAwbSA5AVrt6DxLHfdd+bUg==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.8.1.tgz", + "integrity": "sha512-X4JdU+66Mazev/J0gfXlcC/dV6JI37h+93W9BRYXrSn0hrE64IoWgVkO9MSJgEzoWkxONgaQpICWg8vAN74wlA==", "dev": true, "requires": { - "@typescript-eslint/types": "8.8.0", - "@typescript-eslint/visitor-keys": "8.8.0" + "@typescript-eslint/types": "8.8.1", + "@typescript-eslint/visitor-keys": "8.8.1" } }, "@typescript-eslint/type-utils": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.8.0.tgz", - "integrity": "sha512-IKwJSS7bCqyCeG4NVGxnOP6lLT9Okc3Zj8hLO96bpMkJab+10HIfJbMouLrlpyOr3yrQ1cA413YPFiGd1mW9/Q==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.8.1.tgz", + "integrity": "sha512-qSVnpcbLP8CALORf0za+vjLYj1Wp8HSoiI8zYU5tHxRVj30702Z1Yw4cLwfNKhTPWp5+P+k1pjmD5Zd1nhxiZA==", "dev": true, "requires": { - "@typescript-eslint/typescript-estree": "8.8.0", - "@typescript-eslint/utils": "8.8.0", + "@typescript-eslint/typescript-estree": "8.8.1", + "@typescript-eslint/utils": "8.8.1", "debug": "^4.3.4", "ts-api-utils": "^1.3.0" } }, "@typescript-eslint/types": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.8.0.tgz", - "integrity": "sha512-QJwc50hRCgBd/k12sTykOJbESe1RrzmX6COk8Y525C9l7oweZ+1lw9JiU56im7Amm8swlz00DRIlxMYLizr2Vw==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.8.1.tgz", + "integrity": "sha512-WCcTP4SDXzMd23N27u66zTKMuEevH4uzU8C9jf0RO4E04yVHgQgW+r+TeVTNnO1KIfrL8ebgVVYYMMO3+jC55Q==", "dev": true }, "@typescript-eslint/typescript-estree": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.8.0.tgz", - "integrity": "sha512-ZaMJwc/0ckLz5DaAZ+pNLmHv8AMVGtfWxZe/x2JVEkD5LnmhWiQMMcYT7IY7gkdJuzJ9P14fRy28lUrlDSWYdw==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.8.1.tgz", + "integrity": "sha512-A5d1R9p+X+1js4JogdNilDuuq+EHZdsH9MjTVxXOdVFfTJXunKJR/v+fNNyO4TnoOn5HqobzfRlc70NC6HTcdg==", "dev": true, "requires": { - "@typescript-eslint/types": "8.8.0", - "@typescript-eslint/visitor-keys": "8.8.0", + "@typescript-eslint/types": "8.8.1", + "@typescript-eslint/visitor-keys": "8.8.1", "debug": "^4.3.4", "fast-glob": "^3.3.2", "is-glob": "^4.0.3", @@ -15244,24 +15245,24 @@ } }, "@typescript-eslint/utils": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.8.0.tgz", - "integrity": "sha512-QE2MgfOTem00qrlPgyByaCHay9yb1+9BjnMFnSFkUKQfu7adBXDTnCAivURnuPPAG/qiB+kzKkZKmKfaMT0zVg==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.8.1.tgz", + "integrity": "sha512-/QkNJDbV0bdL7H7d0/y0qBbV2HTtf0TIyjSDTvvmQEzeVx8jEImEbLuOA4EsvE8gIgqMitns0ifb5uQhMj8d9w==", "dev": true, "requires": { "@eslint-community/eslint-utils": "^4.4.0", - "@typescript-eslint/scope-manager": "8.8.0", - "@typescript-eslint/types": "8.8.0", - "@typescript-eslint/typescript-estree": "8.8.0" + "@typescript-eslint/scope-manager": "8.8.1", + "@typescript-eslint/types": "8.8.1", + "@typescript-eslint/typescript-estree": "8.8.1" } }, "@typescript-eslint/visitor-keys": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.8.0.tgz", - "integrity": "sha512-8mq51Lx6Hpmd7HnA2fcHQo3YgfX1qbccxQOgZcb4tvasu//zXRaA1j5ZRFeCw/VRAdFi4mRM9DnZw0Nu0Q2d1g==", + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.8.1.tgz", + "integrity": "sha512-0/TdC3aeRAsW7MDvYRwEc1Uwm0TIBfzjPFgg60UU2Haj5qsCs9cc3zNgY71edqE3LbWfF/WoZQd3lJoDXFQpag==", "dev": true, "requires": { - "@typescript-eslint/types": "8.8.0", + "@typescript-eslint/types": "8.8.1", "eslint-visitor-keys": "^3.4.3" } }, @@ -17178,9 +17179,9 @@ } }, "eslint-module-utils": { - "version": "2.10.0", - "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.10.0.tgz", - "integrity": "sha512-/AXiipjFyfLIUj3E4FR5NEGWoGDZHDfcGzWZkwobRc8fwqUAcy9owTk2LIKwNmtYL8Ad9/XfjSXbGHZ9AJWDEg==", + "version": "2.12.0", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.12.0.tgz", + "integrity": "sha512-wALZ0HFoytlyh/1+4wuZ9FJCD/leWHQzzrxJ8+rebyReSLk7LApMyd3WJaLVoN+D5+WIdJyDK1c6JnE65V4Zyg==", "dev": true, "requires": { "debug": "^3.2.7" @@ -17237,9 +17238,9 @@ } }, "eslint-plugin-import": { - "version": "2.30.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.30.0.tgz", - "integrity": "sha512-/mHNE9jINJfiD2EKkg1BKyPyUk4zdnT54YgbOgfjSakWT5oyX/qQLVNTkehyfpcMxZXMy1zyonZ2v7hZTX43Yw==", + "version": "2.31.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.31.0.tgz", + "integrity": "sha512-ixmkI62Rbc2/w8Vfxyh1jQRTdRTF52VxwRVHl/ykPAmqG+Nb7/kNn+byLP0LxPgI7zWA16Jt82SybJInmMia3A==", "dev": true, "requires": { "@rtsao/scc": "^1.1.0", @@ -17250,7 +17251,7 @@ "debug": "^3.2.7", "doctrine": "^2.1.0", "eslint-import-resolver-node": "^0.3.9", - "eslint-module-utils": "^2.9.0", + "eslint-module-utils": "^2.12.0", "hasown": "^2.0.2", "is-core-module": "^2.15.1", "is-glob": "^4.0.3", @@ -17259,6 +17260,7 @@ "object.groupby": "^1.0.3", "object.values": "^1.2.0", "semver": "^6.3.1", + "string.prototype.trimend": "^1.0.8", "tsconfig-paths": "^3.15.0" }, "dependencies": { @@ -22360,9 +22362,9 @@ "dev": true }, "typescript": { - "version": "5.6.2", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.2.tgz", - "integrity": "sha512-NW8ByodCSNCwZeghjN3o+JX5OFH0Ojg6sadjEKY4huZ52TqbJTJnDo5+Tw98lSy63NZvi4n+ez5m2u5d4PkZyw==" + "version": "5.6.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.3.tgz", + "integrity": "sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==" }, "ua-parser-js": { "version": "1.0.36", diff --git a/package.json b/package.json index f2884731..9a74663e 100644 --- a/package.json +++ b/package.json @@ -100,8 +100,8 @@ "@redocly/cli": "^1.5.0", "@types/jest": "^29.5.13", "@types/js-yaml": "^4.0.9", - "@typescript-eslint/eslint-plugin": "^8.8.0", - "@typescript-eslint/parser": "^8.8.0", + "@typescript-eslint/eslint-plugin": "^8.8.1", + "@typescript-eslint/parser": "^8.8.1", "audit-ci": "^7.1.0", "browser-sync": "^3.0.3", "diff": "^7.0.0", @@ -110,7 +110,7 @@ "eslint-config-standard": "^17.1.0", "eslint-import-resolver-typescript": "^3.6.3", "eslint-plugin-cucumber": "^2.0.0", - "eslint-plugin-import": "^2.30.0", + "eslint-plugin-import": "^2.31.0", "eslint-plugin-node": "^11.1.0", "eslint-plugin-prettier": "^5.2.1", "eslint-plugin-promise": "^6.2.0", @@ -127,7 +127,7 @@ "ts-node": "^10.9.2", "ts-patch": "^3.2.1", "tslib": "^2.7.0", - "typescript": "^5.6.2" + "typescript": "^5.6.3" }, "publishConfig": { "registry": "https://registry.npmjs.org/" From 38222059a5a7a7265a1ba81342b59460a987dec0 Mon Sep 17 00:00:00 2001 From: Kevin Leyow Date: Thu, 10 Oct 2024 09:35:55 -0500 Subject: [PATCH 09/10] chore: rebuild --- ...pter-backend-v2_1_0-openapi3-snippets.yaml | 92 +++++++++++++++ .../v2_1_0/backend/paths/fxTransfersById.yaml | 2 +- .../v2_1_0/backend/json-schemas.json | 109 ++++++++++++++++++ .../v2_1_0/backend/openapi.ts | 65 ++++++++++- .../v2_1_0/backend/schemas.ts | 1 + .../v2_1_0/backend/types.ts | 1 + 6 files changed, 268 insertions(+), 2 deletions(-) diff --git a/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml b/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml index afe56d26..da329671 100644 --- a/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +++ b/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml @@ -447,6 +447,26 @@ paths: $ref: '#/components/responses/400' '500': $ref: '#/components/responses/500' + patch: + description: The HTTP request `PATCH /fxTransfers/{commitRequestId}` is used to notify an FXP backend about the status of currency conversion. + summary: FX Update Conversion State Notification + tags: + - Fx + operationId: FxTransfersPatchById + requestBody: + description: Update and notify status of the FX transfer. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/FxTransfersPatchBackendRequest' + responses: + '200': + $ref: '#/components/responses/200' + '400': + $ref: '#/components/responses/400' + '500': + $ref: '#/components/responses/500' components: parameters: idSubValue: @@ -2496,6 +2516,78 @@ components: $ref: '#/components/schemas/ExtensionList' required: - conversionState + FxTransfersPatchBackendRequest: + title: fxTransfersPatchBackendRequest + description: PATCH /fxTransfers/{commitRequestId} object. + type: object + properties: + conversionId: + type: string + fxQuote: + properties: + fulfilment: + type: string + internalRequest: + type: object + mojaloopResponse: + type: object + request: + type: object + response: + type: object + type: object + fxQuoteRequest: + properties: + body: + type: object + headers: + type: object + type: object + fxQuoteResponse: + properties: + body: + type: string + headers: + type: object + type: object + direction: + enum: + - INBOUND + type: string + currentState: + type: string + enum: + - COMPLETED + - ABORTED + - ERROR_OCCURRED + initiatedTimestamp: + type: string + lastError: + type: string + fxPrepare: + properties: + body: + type: object + headers: + type: object + type: object + fulfil: + properties: + body: + type: object + headers: + type: object + type: object + finalNotification: + properties: + completedTimestamp: + type: string + conversionState: + type: string + required: + - completedTimestamp + - conversionState + type: object responses: '200': description: OK diff --git a/sdk-scheme-adapter/v2_1_0/backend/paths/fxTransfersById.yaml b/sdk-scheme-adapter/v2_1_0/backend/paths/fxTransfersById.yaml index dd5bd254..6c26b16b 100644 --- a/sdk-scheme-adapter/v2_1_0/backend/paths/fxTransfersById.yaml +++ b/sdk-scheme-adapter/v2_1_0/backend/paths/fxTransfersById.yaml @@ -25,7 +25,7 @@ patch: summary: FX Update Conversion State Notification tags: - Fx - operationId: FxTransfersById + operationId: FxTransfersPatchById requestBody: description: Update and notify status of the FX transfer. required: true diff --git a/src/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json b/src/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json index f9a90b93..edabf83d 100644 --- a/src/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json +++ b/src/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json @@ -26894,5 +26894,114 @@ "required": [ "conversionState" ] + }, + "FxTransfersPatchBackendRequest": { + "title": "fxTransfersPatchBackendRequest", + "description": "PATCH /fxTransfers/{commitRequestId} object.", + "type": "object", + "properties": { + "conversionId": { + "type": "string" + }, + "fxQuote": { + "properties": { + "fulfilment": { + "type": "string" + }, + "internalRequest": { + "type": "object" + }, + "mojaloopResponse": { + "type": "object" + }, + "request": { + "type": "object" + }, + "response": { + "type": "object" + } + }, + "type": "object" + }, + "fxQuoteRequest": { + "properties": { + "body": { + "type": "object" + }, + "headers": { + "type": "object" + } + }, + "type": "object" + }, + "fxQuoteResponse": { + "properties": { + "body": { + "type": "string" + }, + "headers": { + "type": "object" + } + }, + "type": "object" + }, + "direction": { + "enum": [ + "INBOUND" + ], + "type": "string" + }, + "currentState": { + "type": "string", + "enum": [ + "COMPLETED", + "ABORTED", + "ERROR_OCCURRED" + ] + }, + "initiatedTimestamp": { + "type": "string" + }, + "lastError": { + "type": "string" + }, + "fxPrepare": { + "properties": { + "body": { + "type": "object" + }, + "headers": { + "type": "object" + } + }, + "type": "object" + }, + "fulfil": { + "properties": { + "body": { + "type": "object" + }, + "headers": { + "type": "object" + } + }, + "type": "object" + }, + "finalNotification": { + "properties": { + "completedTimestamp": { + "type": "string" + }, + "conversionState": { + "type": "string" + } + }, + "required": [ + "completedTimestamp", + "conversionState" + ], + "type": "object" + } + } } } \ No newline at end of file diff --git a/src/sdk-scheme-adapter/v2_1_0/backend/openapi.ts b/src/sdk-scheme-adapter/v2_1_0/backend/openapi.ts index 7f069ed1..f82fd326 100644 --- a/src/sdk-scheme-adapter/v2_1_0/backend/openapi.ts +++ b/src/sdk-scheme-adapter/v2_1_0/backend/openapi.ts @@ -364,7 +364,11 @@ export interface paths { delete?: never; options?: never; head?: never; - patch?: never; + /** + * FX Update Conversion State Notification + * @description The HTTP request `PATCH /fxTransfers/{commitRequestId}` is used to notify an FXP backend about the status of currency conversion. + */ + patch: operations["FxTransfersPatchById"]; trace?: never; }; } @@ -1262,6 +1266,46 @@ export interface components { conversionState: components["schemas"]["conversionState"]; extensionList?: components["schemas"]["ExtensionList"]; }; + /** + * fxTransfersPatchBackendRequest + * @description PATCH /fxTransfers/{commitRequestId} object. + */ + FxTransfersPatchBackendRequest: { + conversionId?: string; + fxQuote?: { + fulfilment?: string; + internalRequest?: Record; + mojaloopResponse?: Record; + request?: Record; + response?: Record; + }; + fxQuoteRequest?: { + body?: Record; + headers?: Record; + }; + fxQuoteResponse?: { + body?: string; + headers?: Record; + }; + /** @enum {string} */ + direction?: "INBOUND"; + /** @enum {string} */ + currentState?: "COMPLETED" | "ABORTED" | "ERROR_OCCURRED"; + initiatedTimestamp?: string; + lastError?: string; + fxPrepare?: { + body?: Record; + headers?: Record; + }; + fulfil?: { + body?: Record; + headers?: Record; + }; + finalNotification?: { + completedTimestamp: string; + conversionState: string; + }; + }; }; responses: { /** @description OK */ @@ -1838,4 +1882,23 @@ export interface operations { 500: components["responses"]["500"]; }; }; + FxTransfersPatchById: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Update and notify status of the FX transfer. */ + requestBody: { + content: { + "application/json": components["schemas"]["FxTransfersPatchBackendRequest"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; + }; } diff --git a/src/sdk-scheme-adapter/v2_1_0/backend/schemas.ts b/src/sdk-scheme-adapter/v2_1_0/backend/schemas.ts index 897a2741..36458215 100644 --- a/src/sdk-scheme-adapter/v2_1_0/backend/schemas.ts +++ b/src/sdk-scheme-adapter/v2_1_0/backend/schemas.ts @@ -134,4 +134,5 @@ export namespace Schemas { export const conversionState = JsonSchemas.conversionState export const FxTransfersPostBackendResponse = JsonSchemas.FxTransfersPostBackendResponse export const FxTransfersPutBackendRequest = JsonSchemas.FxTransfersPutBackendRequest + export const FxTransfersPatchBackendRequest = JsonSchemas.FxTransfersPatchBackendRequest } diff --git a/src/sdk-scheme-adapter/v2_1_0/backend/types.ts b/src/sdk-scheme-adapter/v2_1_0/backend/types.ts index 31aa9056..4a2e3dbb 100644 --- a/src/sdk-scheme-adapter/v2_1_0/backend/types.ts +++ b/src/sdk-scheme-adapter/v2_1_0/backend/types.ts @@ -134,4 +134,5 @@ export namespace Types { export type conversionState = components['schemas']['conversionState'] export type FxTransfersPostBackendResponse = components['schemas']['FxTransfersPostBackendResponse'] export type FxTransfersPutBackendRequest = components['schemas']['FxTransfersPutBackendRequest'] + export type FxTransfersPatchBackendRequest = components['schemas']['FxTransfersPatchBackendRequest'] } From e0f810c8141fc4b4f2a05e0d57b1014d8a4e7cd5 Mon Sep 17 00:00:00 2001 From: Kevin Leyow Date: Thu, 10 Oct 2024 11:05:50 -0500 Subject: [PATCH 10/10] chore: remove slev --- ...-rest-v2.0-ISO20022-openapi3-snippets.yaml | 12 +++---- .../schemas/ChargeBearerType1Code.yaml | 3 -- ...ecute_FIToFICustomerCreditTransferV13.yaml | 4 +-- ...Response_FICreditTransferConfirmation.yaml | 4 +-- ...FinancialInstitutionCreditTransferV12.yaml | 6 ++-- src/fspiop/v2_0_ISO20022/json-schemas.json | 33 ++++++++----------- src/fspiop/v2_0_ISO20022/openapi.ts | 10 +++--- 7 files changed, 29 insertions(+), 43 deletions(-) diff --git a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml index da61d9da..b48f4199 100644 --- a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +++ b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml @@ -1896,15 +1896,11 @@ components: the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver - SLEV : FollowingServiceLevel Charges are to be applied following the - rules - agreed in the service level. type: string enum: - DEBT - CRED - SHAR - - SLEV example: DEBT ChargeType3Choice: title: ChargeType3Choice @@ -2839,7 +2835,7 @@ components: InstdAmt: Amt: 123 Ccy: EUR - ChrgBr: SLEV + ChrgBr: SHAR CdtrAgt: FinInstnId: BICFI: 123 @@ -3352,7 +3348,7 @@ components: IntrBkSttlmAmt: Amt: 100 Ccy: EUR - ChrgBr: SLEV + ChrgBr: SHAR Cdtr: Nm: Creditor Name CdtrAcct: @@ -3411,7 +3407,7 @@ components: 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. + instructions. properties: GrpHdr: allOf: @@ -3468,7 +3464,7 @@ components: IntrBkSttlmAmt: Amt: 1000 Ccy: EUR - ChrgBr: SLEV + ChrgBr: SHAR CdtrAgt: FinInstnId: BICFI: CCCCCCCC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml index 8fae7971..0b9f809b 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml @@ -9,12 +9,9 @@ description: | the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver - SLEV : FollowingServiceLevel Charges are to be applied following the rules - agreed in the service level. type: string enum: - DEBT - CRED - SHAR - - SLEV example: DEBT diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml index eeb5cc83..b3992756 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml @@ -42,7 +42,7 @@ example: InstdAmt: Amt: 123 Ccy: EUR - ChrgBr: SLEV + ChrgBr: SHAR CdtrAgt: FinInstnId: BICFI: 123 @@ -52,4 +52,4 @@ example: Id: IBAN: 123 RmtInf: - Ustrd: Test \ No newline at end of file + Ustrd: Test diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml index ccd39475..9af7ca11 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml @@ -42,7 +42,7 @@ example: IntrBkSttlmAmt: Amt: 100.00 Ccy: EUR - ChrgBr: SLEV + ChrgBr: SHAR Cdtr: Nm: Creditor Name CdtrAcct: @@ -92,4 +92,4 @@ example: Tp: Cd: CACC Ccy: EUR - Nm: My account \ No newline at end of file + Nm: My account diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml index 251f4486..f9291b99 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml @@ -1,7 +1,7 @@ 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. + 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. properties: GrpHdr: allOf: @@ -56,7 +56,7 @@ example: IntrBkSttlmAmt: Amt: 1000 Ccy: EUR - ChrgBr: SLEV + ChrgBr: SHAR CdtrAgt: FinInstnId: BICFI: CCCCCCCC @@ -66,4 +66,4 @@ example: Id: IBAN: BE71096123456769 RmtInf: - Ustrd: Payment for invoice 12345 \ No newline at end of file + Ustrd: Payment for invoice 12345 diff --git a/src/fspiop/v2_0_ISO20022/json-schemas.json b/src/fspiop/v2_0_ISO20022/json-schemas.json index b76de07c..bd32eb64 100644 --- a/src/fspiop/v2_0_ISO20022/json-schemas.json +++ b/src/fspiop/v2_0_ISO20022/json-schemas.json @@ -3482,13 +3482,12 @@ }, "ChargeBearerType1Code": { "title": "ChargeBearerType1Code", - "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\nSLEV : FollowingServiceLevel Charges are to be applied following the rules\n agreed in the service level.\n", + "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", "type": "string", "enum": [ "DEBT", "CRED", - "SHAR", - "SLEV" + "SHAR" ], "example": "DEBT" }, @@ -9858,13 +9857,12 @@ }, "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", + "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", "type": "string", "enum": [ "DEBT", "CRED", - "SHAR", - "SLEV" + "SHAR" ], "example": "DEBT" }, @@ -33090,13 +33088,12 @@ }, "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", + "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", "type": "string", "enum": [ "DEBT", "CRED", - "SHAR", - "SLEV" + "SHAR" ], "example": "DEBT" }, @@ -41860,7 +41857,7 @@ "Amt": 123, "Ccy": "EUR" }, - "ChrgBr": "SLEV", + "ChrgBr": "SHAR", "CdtrAgt": { "FinInstnId": { "BICFI": 123 @@ -63197,7 +63194,7 @@ "Amt": 100, "Ccy": "EUR" }, - "ChrgBr": "SLEV", + "ChrgBr": "SHAR", "Cdtr": { "Nm": "Creditor Name" }, @@ -63278,7 +63275,7 @@ "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", + "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": [ @@ -72955,7 +72952,7 @@ "Amt": 1000, "Ccy": "EUR" }, - "ChrgBr": "SLEV", + "ChrgBr": "SHAR", "CdtrAgt": { "FinInstnId": { "BICFI": "CCCCCCCC" @@ -122456,13 +122453,12 @@ }, "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", + "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", "type": "string", "enum": [ "DEBT", "CRED", - "SHAR", - "SLEV" + "SHAR" ], "example": "DEBT" }, @@ -136123,13 +136119,12 @@ }, "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", + "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", "type": "string", "enum": [ "DEBT", "CRED", - "SHAR", - "SLEV" + "SHAR" ], "example": "DEBT" }, diff --git a/src/fspiop/v2_0_ISO20022/openapi.ts b/src/fspiop/v2_0_ISO20022/openapi.ts index 60d81605..ecb78d41 100644 --- a/src/fspiop/v2_0_ISO20022/openapi.ts +++ b/src/fspiop/v2_0_ISO20022/openapi.ts @@ -812,13 +812,11 @@ export interface components { * the sender side are to be borne by the debtor, transaction charges on the receiver side are to * be borne by the creditor. In a direct debit context, means that transaction charges on the sender side * are to be borne by the creditor, transaction charges on the receiver - * SLEV : FollowingServiceLevel Charges are to be applied following the rules - * agreed in the service level. * * @example DEBT * @enum {string} */ - ChargeBearerType1Code: "DEBT" | "CRED" | "SHAR" | "SLEV"; + ChargeBearerType1Code: "DEBT" | "CRED" | "SHAR"; /** * ChargeType3Choice * @description ChargeType3Choice @@ -1301,7 +1299,7 @@ export interface components { * "Amt": 123, * "Ccy": "EUR" * }, - * "ChrgBr": "SLEV", + * "ChrgBr": "SHAR", * "CdtrAgt": { * "FinInstnId": { * "BICFI": 123 @@ -1712,7 +1710,7 @@ export interface components { * "Amt": 100, * "Ccy": "EUR" * }, - * "ChrgBr": "SLEV", + * "ChrgBr": "SHAR", * "Cdtr": { * "Nm": "Creditor Name" * }, @@ -1851,7 +1849,7 @@ export interface components { * "Amt": 1000, * "Ccy": "EUR" * }, - * "ChrgBr": "SLEV", + * "ChrgBr": "SHAR", * "CdtrAgt": { * "FinInstnId": { * "BICFI": "CCCCCCCC"