diff --git a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml index c5f06a40..7a39add3 100644 --- a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +++ b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml @@ -20,1102 +20,989 @@ servers: paths: /parties/{Type}/{ID}: parameters: - - $ref: "#/components/parameters/Type" - - $ref: "#/components/parameters/ID" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/Type' + - $ref: '#/components/parameters/ID' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' get: - description: >- - The HTTP request `GET /parties/{Type}/{ID}` (or `GET - /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding - the requested Party, defined by `{Type}`, `{ID}` and optionally - `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET - /parties/BUSINESS/shoecompany/employee1`). + description: The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). summary: Look up party information tags: - parties operationId: PartiesByTypeAndID parameters: - - $ref: "#/components/parameters/Accept" + - $ref: '#/components/parameters/Accept' responses: - "202": - $ref: "#/components/responses/202" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '202': + $ref: '#/components/responses/202' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' put: - description: >- - The callback `PUT /parties/{Type}/{ID}` (or `PUT - /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a - successful result of the Party information lookup. + description: The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. summary: Return party information tags: - parties operationId: PartiesByTypeAndID2 parameters: - - $ref: "#/components/parameters/Content-Length" + - $ref: '#/components/parameters/Content-Length' requestBody: description: Party information returned. required: true content: application/json: schema: - $ref: >- - #/components/schemas/GetParties_IdentificationVerificationReportV03 + $ref: '#/components/schemas/GetParties_IdentificationVerificationReportV03' responses: - "200": - $ref: "#/components/responses/200" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '200': + $ref: '#/components/responses/200' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' /parties/{Type}/{ID}/error: put: - description: >- - If the server is unable to find Party information of the provided - identity, or another processing error occurred, the error callback `PUT - /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) - is used. + description: If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used. summary: Return party information error tags: - parties operationId: PartiesErrorByTypeAndID parameters: - - $ref: "#/components/parameters/Type" - - $ref: "#/components/parameters/ID" - - $ref: "#/components/parameters/Content-Length" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/Type' + - $ref: '#/components/parameters/ID' + - $ref: '#/components/parameters/Content-Length' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' requestBody: description: Details of the error returned. required: true content: application/json: schema: - $ref: >- - #/components/schemas/GetPartiesError_IdentificationVerificationReportV03 + $ref: '#/components/schemas/GetPartiesError_IdentificationVerificationReportV03' responses: - "200": - $ref: "#/components/responses/200" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '200': + $ref: '#/components/responses/200' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' /parties/{Type}/{ID}/{SubId}: parameters: - - $ref: "#/components/parameters/Type" - - $ref: "#/components/parameters/ID" - - $ref: "#/components/parameters/SubId" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/Type' + - $ref: '#/components/parameters/ID' + - $ref: '#/components/parameters/SubId' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' get: - description: >- - The HTTP request `GET /parties/{Type}/{ID}` (or `GET - /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding - the requested Party, defined by `{Type}`, `{ID}` and optionally - `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET - /parties/BUSINESS/shoecompany/employee1`). + description: The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). summary: Look up party information tags: - parties operationId: PartiesSubIdByTypeAndID parameters: - - $ref: "#/components/parameters/Accept" + - $ref: '#/components/parameters/Accept' responses: - "202": - $ref: "#/components/responses/202" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '202': + $ref: '#/components/responses/202' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' put: - description: >- - The callback `PUT /parties/{Type}/{ID}` (or `PUT - /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a - successful result of the Party information lookup. + description: The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. summary: Return party information tags: - parties operationId: PartiesSubIdByTypeAndIDPut parameters: - - $ref: "#/components/parameters/Content-Length" + - $ref: '#/components/parameters/Content-Length' requestBody: description: Party information returned. required: true content: application/json: schema: - $ref: >- - #/components/schemas/GetParties_IdentificationVerificationReportV03 + $ref: '#/components/schemas/GetParties_IdentificationVerificationReportV03' responses: - "200": - $ref: "#/components/responses/200" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '200': + $ref: '#/components/responses/200' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' /parties/{Type}/{ID}/{SubId}/error: put: - description: >- - If the server is unable to find Party information of the provided - identity, or another processing error occurred, the error callback `PUT - /parties/{Type}/{ID}/error` (or `PUT - /parties/{Type}/{ID}/{SubId}/error`) is used. + description: If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used. summary: Return party information error tags: - parties operationId: PartiesSubIdErrorByTypeAndID parameters: - - $ref: "#/components/parameters/Type" - - $ref: "#/components/parameters/ID" - - $ref: "#/components/parameters/SubId" - - $ref: "#/components/parameters/Content-Length" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/Type' + - $ref: '#/components/parameters/ID' + - $ref: '#/components/parameters/SubId' + - $ref: '#/components/parameters/Content-Length' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' requestBody: description: Details of the error returned. required: true content: application/json: schema: - $ref: >- - #/components/schemas/GetPartiesError_IdentificationVerificationReportV03 + $ref: '#/components/schemas/GetPartiesError_IdentificationVerificationReportV03' responses: - "200": - $ref: "#/components/responses/200" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '200': + $ref: '#/components/responses/200' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' /quotes: post: - description: >- - The HTTP request `POST /quotes` is used to request the creation of a - quote for the provided financial transaction in the server. + description: The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server. summary: Calculate quote tags: - quotes operationId: Quotes parameters: - - $ref: "#/components/parameters/Accept" - - $ref: "#/components/parameters/Content-Length" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Length' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' requestBody: description: Details of the quote to be created. required: true content: application/json: schema: - $ref: "#/components/schemas/TermsRequest_FIToFICustomerCreditProposal" + $ref: '#/components/schemas/TermsRequest_FIToFICustomerCreditProposal' responses: - "202": - $ref: "#/components/responses/202" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '202': + $ref: '#/components/responses/202' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' /quotes/{ID}: parameters: - - $ref: "#/components/parameters/ID" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/ID' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' get: - description: >- - The HTTP request `GET /quotes/{ID}` is used to get information regarding - a quote created or requested earlier. The `{ID}` in the URI should - contain the `quoteId` that was used for the creation of the quote. + description: The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote. summary: Retrieve quote information tags: - quotes operationId: QuotesByID parameters: - - $ref: "#/components/parameters/Accept" + - $ref: '#/components/parameters/Accept' responses: - "202": - $ref: "#/components/responses/202" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '202': + $ref: '#/components/responses/202' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' put: - description: >- - The callback `PUT /quotes/{ID}` is used to inform the client of a - requested or created quote. The `{ID}` in the URI should contain the - `quoteId` that was used for the creation of the quote, or the `{ID}` - that was used in the `GET /quotes/{ID}` request. + description: The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. summary: Return quote information tags: - quotes operationId: QuotesByID1 parameters: - - $ref: "#/components/parameters/Content-Length" + - $ref: '#/components/parameters/Content-Length' requestBody: description: Quote information returned. required: true content: application/json: schema: - $ref: >- - #/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation + $ref: '#/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation' responses: - "200": - $ref: "#/components/responses/200" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '200': + $ref: '#/components/responses/200' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' /quotes/{ID}/error: put: - description: >- - If the server is unable to find or create a quote, or some other - processing error occurs, the error callback `PUT /quotes/{ID}/error` is - used. The `{ID}` in the URI should contain the `quoteId` that was used - for the creation of the quote, or the `{ID}` that was used in the `GET - /quotes/{ID}` request. + description: If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. summary: Return quote information error tags: - quotes operationId: QuotesByIDAndError parameters: - - $ref: "#/components/parameters/ID" - - $ref: "#/components/parameters/Content-Length" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/ID' + - $ref: '#/components/parameters/Content-Length' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' requestBody: description: Details of the error returned. required: true content: application/json: schema: - $ref: "#/components/schemas/PacsError_FIToFIPaymentStatusReportV15" + $ref: '#/components/schemas/PacsError_FIToFIPaymentStatusReportV15' responses: - "200": - $ref: "#/components/responses/200" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '200': + $ref: '#/components/responses/200' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' /transfers: post: - description: >- - The HTTP request `POST /transfers` is used to request the creation of a - transfer for the next ledger, and a financial transaction for the Payee - FSP. + description: The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP. summary: Perform transfer tags: - transfers operationId: transfers parameters: - - $ref: "#/components/parameters/Accept" - - $ref: "#/components/parameters/Content-Length" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Length' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' requestBody: description: Details of the transfer to be created. required: true content: application/json: schema: - $ref: "#/components/schemas/Execute_FIToFICustomerCreditTransferV13" + $ref: '#/components/schemas/Execute_FIToFICustomerCreditTransferV13' responses: - "202": - $ref: "#/components/responses/202" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '202': + $ref: '#/components/responses/202' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' /transfers/{ID}: parameters: - - $ref: "#/components/parameters/ID" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/ID' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' get: - description: >- - The HTTP request `GET /transfers/{ID}` is used to get information - regarding a transfer created or requested earlier. The `{ID}` in the URI - should contain the `transferId` that was used for the creation of the - transfer. + description: The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer. summary: Retrieve transfer information tags: - transfers operationId: TransfersByIDGet parameters: - - $ref: "#/components/parameters/Accept" + - $ref: '#/components/parameters/Accept' responses: - "202": - $ref: "#/components/responses/202" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '202': + $ref: '#/components/responses/202' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' patch: - description: >- - The HTTP request PATCH /transfers/ is used by a Switch to update the - state of a previously reserved transfer, if the Payee FSP has requested - a commit notification when the Switch has completed processing of the - transfer. The in the URI should contain the transferId that was - used for the creation of the transfer. Please note that this request - does not generate a callback. + description: The HTTP request PATCH /transfers/ is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback. summary: Return transfer information tags: - transfers operationId: TransfersByIDPatch parameters: - - $ref: "#/components/parameters/Content-Length" + - $ref: '#/components/parameters/Content-Length' requestBody: description: Transfer notification upon completion. required: true content: application/json: schema: - $ref: "#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15" + $ref: '#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15patch' responses: - "200": - $ref: "#/components/responses/200" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '200': + $ref: '#/components/responses/200' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' put: - description: >- - The callback `PUT /transfers/{ID}` is used to inform the client of a - requested or created transfer. The `{ID}` in the URI should contain the - `transferId` that was used for the creation of the transfer, or the - `{ID}` that was used in the `GET /transfers/{ID}` request. + description: The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request. summary: Return transfer information tags: - transfers operationId: TransfersByIDPut parameters: - - $ref: "#/components/parameters/Content-Length" + - $ref: '#/components/parameters/Content-Length' requestBody: description: Transfer information returned. required: true content: application/json: schema: - $ref: "#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15" + $ref: '#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15' responses: - "200": - $ref: "#/components/responses/200" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '200': + $ref: '#/components/responses/200' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' /transfers/{ID}/error: put: - description: >- - If the server is unable to find or create a transfer, or another - processing error occurs, the error callback `PUT /transfers/{ID}/error` - is used. The `{ID}` in the URI should contain the `transferId` that was - used for the creation of the transfer, or the `{ID}` that was used in - the `GET /transfers/{ID}`. + description: If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`. summary: Return transfer information error tags: - transfers operationId: TransfersByIDAndError parameters: - - $ref: "#/components/parameters/ID" - - $ref: "#/components/parameters/Content-Length" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/ID' + - $ref: '#/components/parameters/Content-Length' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' requestBody: description: Details of the error returned. required: true content: application/json: schema: - $ref: "#/components/schemas/PacsError_FIToFIPaymentStatusReportV15" + $ref: '#/components/schemas/PacsError_FIToFIPaymentStatusReportV15' responses: - "200": - $ref: "#/components/responses/200" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '200': + $ref: '#/components/responses/200' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' /fxQuotes: post: - description: >- - The HTTP request `POST /fxQuotes` is used to ask an FXP to provide a - quotation for a currency conversion. + description: The HTTP request `POST /fxQuotes` is used to ask an FXP to provide a quotation for a currency conversion. summary: Calculate FX quote tags: - fxQuotes operationId: FxQuotesPost parameters: - - $ref: "#/components/parameters/Accept" - - $ref: "#/components/parameters/Content-Length" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Length' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' requestBody: description: Details of the FX quote to be created. required: true content: application/json: schema: - $ref: "#/components/schemas/FxRequest_FICreditTransferProposal" + $ref: '#/components/schemas/FxRequest_FICreditTransferProposal' responses: - "202": - $ref: "#/components/responses/202" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '202': + $ref: '#/components/responses/202' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' /fxQuotes/{ID}: parameters: - - $ref: "#/components/parameters/ID" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/ID' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' get: - description: >- - The HTTP request `GET /fxQuotes/{ID}` is used to request information - regarding a request for quotation for a currency conversion which the - sender has previously issued. The `{ID}` in the URI should contain the - `conversionRequestId` that was used for the creation of the quote. + description: The HTTP request `GET /fxQuotes/{ID}` is used to request information regarding a request for quotation for a currency conversion which the sender has previously issued. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the quote. summary: Retrieve FX quote information tags: - fxQuotes operationId: FxQuotesByIDGet parameters: - - $ref: "#/components/parameters/Accept" + - $ref: '#/components/parameters/Accept' responses: - "202": - $ref: "#/components/responses/202" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '202': + $ref: '#/components/responses/202' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' put: - description: >- - The callback `PUT /fxQuotes/{ID}` is used to inform the requester about - the outcome of a request for quotation for a currency conversion. The - `{ID}` in the URI should contain the `conversionRequestId` that was used - for the creation of the FX quote, or the `{ID}` that was used in the - `GET /fxQuotes/{ID}` request. + description: The callback `PUT /fxQuotes/{ID}` is used to inform the requester about the outcome of a request for quotation for a currency conversion. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the FX quote, or the `{ID}` that was used in the `GET /fxQuotes/{ID}` request. summary: Return FX quote information tags: - fxQuotes operationId: FxQuotesByIdPut parameters: - - $ref: "#/components/parameters/Content-Length" + - $ref: '#/components/parameters/Content-Length' requestBody: description: FX Quote information returned. required: true content: application/json: schema: - $ref: "#/components/schemas/FxResponse_FICreditTransferConfirmation" + $ref: '#/components/schemas/FxResponse_FICreditTransferConfirmation' responses: - "200": - $ref: "#/components/responses/200" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '200': + $ref: '#/components/responses/200' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' /fxQuotes/{ID}/error: put: - description: >- - If the FXP is unable to find or create a FX quote, or some other - processing error occurs, the error callback `PUT /fxQuotes/{ID}/error` - is used. The `{ID}` in the URI should contain the `conversionRequestId` - that was used for the creation of the FX quote, or the `{ID}` that was - used in the `GET /fxQuotes/{ID}` request. + description: If the FXP is unable to find or create a FX quote, or some other processing error occurs, the error callback `PUT /fxQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the FX quote, or the `{ID}` that was used in the `GET /fxQuotes/{ID}` request. summary: Return FX quote information error tags: - fxQuotes operationId: FxQuotesByIDAndErrorPut parameters: - - $ref: "#/components/parameters/ID" - - $ref: "#/components/parameters/Content-Length" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/ID' + - $ref: '#/components/parameters/Content-Length' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' requestBody: description: Details of the error returned. required: true content: application/json: schema: - $ref: "#/components/schemas/PacsError_FIToFIPaymentStatusReportV15" + $ref: '#/components/schemas/PacsError_FIToFIPaymentStatusReportV15' responses: - "200": - $ref: "#/components/responses/200" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '200': + $ref: '#/components/responses/200' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' /fxTransfers: post: - description: >- - The HTTP request `POST /fxTransfers` is used to ask an FXP to confirm - the execution of an agreed currency conversion. + description: The HTTP request `POST /fxTransfers` is used to ask an FXP to confirm the execution of an agreed currency conversion. summary: Perform FX transfer tags: - fxTransfers operationId: FxTransfersPost parameters: - - $ref: "#/components/parameters/Accept" - - $ref: "#/components/parameters/Content-Length" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Content-Length' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' requestBody: description: Details of the FX transfer to be created. required: true content: application/json: schema: - $ref: >- - #/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12 + $ref: '#/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12' responses: - "202": - $ref: "#/components/responses/202" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '202': + $ref: '#/components/responses/202' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' /fxTransfers/{ID}: parameters: - - $ref: "#/components/parameters/ID" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/ID' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' get: - description: >- - The HTTP request `GET /fxTransfers/{ID}` s used to request information - regarding a request for confirmation of a currency conversion which the - sender has previously issued. The `{ID}` in the URI should contain the - `commitRequestId` that was used for the creation of the FX transfer. + description: The HTTP request `GET /fxTransfers/{ID}` s used to request information regarding a request for confirmation of a currency conversion which the sender has previously issued. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer. summary: Retrieve FX transfer information tags: - fxTransfers operationId: FxTransfersByIDGet parameters: - - $ref: "#/components/parameters/Accept" + - $ref: '#/components/parameters/Accept' responses: - "202": - $ref: "#/components/responses/202" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '202': + $ref: '#/components/responses/202' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' patch: - description: >- - The HTTP request PATCH /fxTransfers/ is used to inform the requester - about the final determination by the switch of the transfer a request - for execution of a currency conversion. The in the URI should - contain the commitRequestId that was used for the creation of the FX - transfer. Please note that this request does not generate a callback. + description: The HTTP request PATCH /fxTransfers/ is used to inform the requester about the final determination by the switch of the transfer a request for execution of a currency conversion. The in the URI should contain the commitRequestId that was used for the creation of the FX transfer. Please note that this request does not generate a callback. summary: Return FX transfer information tags: - fxTransfers operationId: FxTransfersByIDPatch parameters: - - $ref: "#/components/parameters/Content-Length" + - $ref: '#/components/parameters/Content-Length' requestBody: description: Transfer notification upon completion. required: true content: application/json: schema: - $ref: "#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15" + $ref: '#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15patch' responses: - "200": - $ref: "#/components/responses/200" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '200': + $ref: '#/components/responses/200' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' put: - description: >- - The callback `PUT /fxTransfers/{ID}` is used to inform the requester - about the outcome of a request for execution of a currency conversion. - The `{ID}` in the URI should contain the `commitRequestId` that was used - for the creation of the FX transfer, or the `{ID}` that was used in the - `GET /fxTransfers/{ID}` request. + description: The callback `PUT /fxTransfers/{ID}` is used to inform the requester about the outcome of a request for execution of a currency conversion. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer, or the `{ID}` that was used in the `GET /fxTransfers/{ID}` request. summary: Return FX transfer information tags: - fxTransfers operationId: FxTransfersByIDPut parameters: - - $ref: "#/components/parameters/Content-Length" + - $ref: '#/components/parameters/Content-Length' requestBody: description: Transfer information returned. required: true content: application/json: schema: - $ref: "#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15" + $ref: '#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15' responses: - "200": - $ref: "#/components/responses/200" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '200': + $ref: '#/components/responses/200' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' /fxTransfers/{ID}/error: put: - description: >- - If the switch or FXP is unable to find or create a FX transfer, or - another processing error occurs, the error callback `PUT - /fxTransfers/{ID}/error` is used. The `{ID}` in the URI should contain - the `commitRequestId` that was used for the creation of the FX transfer, - or the `{ID}` that was used in the `GET /fxTransfers/{ID}`. + description: If the switch or FXP is unable to find or create a FX transfer, or another processing error occurs, the error callback `PUT /fxTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer, or the `{ID}` that was used in the `GET /fxTransfers/{ID}`. summary: Return FX transfer information error tags: - fxTransfers operationId: FxTransfersByIDAndErrorPut parameters: - - $ref: "#/components/parameters/ID" - - $ref: "#/components/parameters/Content-Length" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/Date" - - $ref: "#/components/parameters/X-Forwarded-For" - - $ref: "#/components/parameters/FSPIOP-Source" - - $ref: "#/components/parameters/FSPIOP-Destination" - - $ref: "#/components/parameters/FSPIOP-Encryption" - - $ref: "#/components/parameters/FSPIOP-Signature" - - $ref: "#/components/parameters/FSPIOP-URI" - - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + - $ref: '#/components/parameters/ID' + - $ref: '#/components/parameters/Content-Length' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Date' + - $ref: '#/components/parameters/X-Forwarded-For' + - $ref: '#/components/parameters/FSPIOP-Source' + - $ref: '#/components/parameters/FSPIOP-Destination' + - $ref: '#/components/parameters/FSPIOP-Encryption' + - $ref: '#/components/parameters/FSPIOP-Signature' + - $ref: '#/components/parameters/FSPIOP-URI' + - $ref: '#/components/parameters/FSPIOP-HTTP-Method' requestBody: description: Details of the error returned. required: true content: application/json: schema: - $ref: "#/components/schemas/PacsError_FIToFIPaymentStatusReportV15" + $ref: '#/components/schemas/PacsError_FIToFIPaymentStatusReportV15' responses: - "200": - $ref: "#/components/responses/200" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "405": - $ref: "#/components/responses/405" - "406": - $ref: "#/components/responses/406" - "501": - $ref: "#/components/responses/501" - "503": - $ref: "#/components/responses/503" + '200': + $ref: '#/components/responses/200' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '405': + $ref: '#/components/responses/405' + '406': + $ref: '#/components/responses/406' + '501': + $ref: '#/components/responses/501' + '503': + $ref: '#/components/responses/503' components: parameters: - Accept: - name: Accept - in: header + Type: + name: Type + in: path required: true schema: type: string - description: >- - The `Accept` header field indicates the version of the API the client - would like the server to use. - Content-Length: - name: Content-Length - in: header - required: false + description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. + ID: + name: ID + in: path + required: true schema: - type: integer - description: >- - The `Content-Length` header field indicates the anticipated size of the - payload body. Only sent if there is a body. - - - **Note:** The API supports a maximum size of 5242880 bytes (5 - Megabytes). + type: string + description: The identifier value. Content-Type: name: Content-Type in: header schema: type: string required: true - description: >- - The `Content-Type` header indicates the specific version of the API used - to send the payload body. + description: The `Content-Type` header indicates the specific version of the API used to send the payload body. Date: name: Date in: header @@ -1123,929 +1010,1202 @@ components: type: string required: true description: The `Date` header field indicates the date when the request was sent. - FSPIOP-Destination: - name: FSPIOP-Destination + X-Forwarded-For: + name: X-Forwarded-For in: header schema: type: string required: false - description: >- - The `FSPIOP-Destination` header field is a non-HTTP standard field used - by the API for HTTP header based routing of requests and responses to - the destination. The field must be set by the original sender of the - request if the destination is known (valid for all services except GET - /parties) so that any entities between the client and the server do not - need to parse the payload for routing purposes. If the destination is - not known (valid for service GET /parties), the field should be left - empty. - FSPIOP-Encryption: - name: FSPIOP-Encryption + description: |- + The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + + **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. + FSPIOP-Source: + name: FSPIOP-Source + in: header + schema: + type: string + required: true + description: The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). + FSPIOP-Destination: + name: FSPIOP-Destination in: header schema: type: string required: false - description: >- - The `FSPIOP-Encryption` header field is a non-HTTP standard field used - by the API for applying end-to-end encryption of the request. - FSPIOP-HTTP-Method: - name: FSPIOP-HTTP-Method + description: The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. + FSPIOP-Encryption: + name: FSPIOP-Encryption in: header schema: type: string required: false - description: >- - The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used - by the API for signature verification, should contain the service HTTP - method. Required if signature verification is used, for more - information, see [the API Signature - document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). + description: The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. FSPIOP-Signature: name: FSPIOP-Signature in: header schema: type: string required: false - description: >- - The `FSPIOP-Signature` header field is a non-HTTP standard field used by - the API for applying an end-to-end request signature. - FSPIOP-Source: - name: FSPIOP-Source + description: The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. + FSPIOP-URI: + name: FSPIOP-URI in: header schema: type: string - required: true - description: >- - The `FSPIOP-Source` header field is a non-HTTP standard field used by - the API for identifying the sender of the HTTP request. The field should - be set by the original sender of the request. Required for routing and - signature verification (see header field `FSPIOP-Signature`). - FSPIOP-URI: - name: FSPIOP-URI + required: false + description: The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). + FSPIOP-HTTP-Method: + name: FSPIOP-HTTP-Method in: header schema: type: string required: false - description: >- - The `FSPIOP-URI` header field is a non-HTTP standard field used by the - API for signature verification, should contain the service URI. Required - if signature verification is used, for more information, see [the API - Signature - document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). - ID: - name: ID - in: path + description: The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). + Accept: + name: Accept + in: header required: true schema: type: string - description: The identifier value. + description: The `Accept` header field indicates the version of the API the client would like the server to use. + Content-Length: + name: Content-Length + in: header + required: false + schema: + type: integer + description: |- + The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + + **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). SubId: name: SubId in: path required: true schema: type: string - description: >- - A sub-identifier of the party identifier, or a sub-type of the party - identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. - Type: - name: Type - in: path - required: true - schema: - type: string - description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. - X-Forwarded-For: - name: X-Forwarded-For - in: header - schema: - type: string - required: false - description: >- - The `X-Forwarded-For` header field is an unofficially accepted standard - used for informational purposes of the originating client IP address, as - a request might pass multiple proxies, firewalls, and so on. Multiple - `X-Forwarded-For` values should be expected and supported by - implementers of the API. - - - **Note:** An alternative to `X-Forwarded-For` is defined in [RFC - 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC - 7239 is less-used and supported than `X-Forwarded-For`. + description: A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. responses: - "200": + '200': description: OK - "202": + '202': description: Accepted - "400": + '400': description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/ErrorInformationResponse" + $ref: '#/components/schemas/ErrorInformationResponse' headers: Content-Length: - $ref: "#/components/headers/Content-Length" + $ref: '#/components/headers/Content-Length' Content-Type: - $ref: "#/components/headers/Content-Type" - "401": + $ref: '#/components/headers/Content-Type' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorInformationResponse" + $ref: '#/components/schemas/ErrorInformationResponse' headers: Content-Length: - $ref: "#/components/headers/Content-Length" + $ref: '#/components/headers/Content-Length' Content-Type: - $ref: "#/components/headers/Content-Type" - "403": + $ref: '#/components/headers/Content-Type' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorInformationResponse" + $ref: '#/components/schemas/ErrorInformationResponse' headers: Content-Length: - $ref: "#/components/headers/Content-Length" + $ref: '#/components/headers/Content-Length' Content-Type: - $ref: "#/components/headers/Content-Type" - "404": + $ref: '#/components/headers/Content-Type' + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorInformationResponse" + $ref: '#/components/schemas/ErrorInformationResponse' headers: Content-Length: - $ref: "#/components/headers/Content-Length" + $ref: '#/components/headers/Content-Length' Content-Type: - $ref: "#/components/headers/Content-Type" - "405": + $ref: '#/components/headers/Content-Type' + '405': description: Method Not Allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorInformationResponse" + $ref: '#/components/schemas/ErrorInformationResponse' headers: Content-Length: - $ref: "#/components/headers/Content-Length" + $ref: '#/components/headers/Content-Length' Content-Type: - $ref: "#/components/headers/Content-Type" - "406": + $ref: '#/components/headers/Content-Type' + '406': description: Not Acceptable content: application/json: schema: - $ref: "#/components/schemas/ErrorInformationResponse" + $ref: '#/components/schemas/ErrorInformationResponse' headers: Content-Length: - $ref: "#/components/headers/Content-Length" + $ref: '#/components/headers/Content-Length' Content-Type: - $ref: "#/components/headers/Content-Type" - "501": + $ref: '#/components/headers/Content-Type' + '501': description: Not Implemented content: application/json: schema: - $ref: "#/components/schemas/ErrorInformationResponse" + $ref: '#/components/schemas/ErrorInformationResponse' headers: Content-Length: - $ref: "#/components/headers/Content-Length" + $ref: '#/components/headers/Content-Length' Content-Type: - $ref: "#/components/headers/Content-Type" - "503": + $ref: '#/components/headers/Content-Type' + '503': description: Service Unavailable content: application/json: schema: - $ref: "#/components/schemas/ErrorInformationResponse" + $ref: '#/components/schemas/ErrorInformationResponse' headers: Content-Length: - $ref: "#/components/headers/Content-Length" + $ref: '#/components/headers/Content-Length' Content-Type: - $ref: "#/components/headers/Content-Type" + $ref: '#/components/headers/Content-Type' headers: Content-Length: required: false schema: type: integer - description: >- - The `Content-Length` header field indicates the anticipated size of the - payload body. Only sent if there is a body. + description: |- + The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. - - **Note:** The API supports a maximum size of 5242880 bytes (5 - Megabytes). + **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). Content-Type: schema: type: string required: true - description: >- - The `Content-Type` header indicates the specific version of the API used - to send the payload body. + description: The `Content-Type` header indicates the specific version of the API used to send the payload body. schemas: - AccountIdentification4Choice: - title: AccountIdentification4Choice + 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. + ExtensionKey: + title: ExtensionKey + type: string + minLength: 1 + maxLength: 32 + description: Extension key. + ExtensionValue: + title: ExtensionValue + type: string + minLength: 1 + maxLength: 128 + description: Extension value. + Extension: + title: Extension type: object - description: > - Specifies the unique identification of an account as assigned by the - account servicer. - anyOf: - - properties: - IBAN: - allOf: - - $ref: "#/components/schemas/IBAN2007Identifier" - - description: > - IBAN + description: Data model for the complex type Extension. + properties: + key: + $ref: '#/components/schemas/ExtensionKey' + value: + $ref: '#/components/schemas/ExtensionValue' + required: + - key + - value + ExtensionList: + title: ExtensionList + type: object + description: | + Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. + properties: + extension: + type: array + items: + $ref: '#/components/schemas/Extension' + minItems: 1 + maxItems: 16 + description: Number of Extension elements. + required: + - extension + ErrorInformation: + title: ErrorInformation + type: object + description: Data model for the complex type ErrorInformation. + properties: + errorCode: + $ref: '#/components/schemas/ErrorCode' + errorDescription: + $ref: '#/components/schemas/ErrorDescription' + extensionList: + $ref: '#/components/schemas/ExtensionList' + 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. + properties: + errorInformation: + $ref: '#/components/schemas/ErrorInformation' + Max35Text: + title: Max35Text + description: | + Specifies a character string with a maximum length of 35 characters. + type: string + minLength: 1 + maxLength: 35 + example: 1.234567890123457e+34 + ISODateTime: + title: ISODateTime + 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 + (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format + (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in + "XML Schema Part 2: Datatypes Second Edition - + W3C Recommendation 28 October 2004" which is aligned with ISO 8601. - International Bank Account Number (IBAN) - identifier used - internationally by financial institutions to uniquely - identify the account of a customer. Further specifications - of the format and content of the IBAN can be found in the - standard ISO 13616 "Banking and related financial services - - International Bank Account Number (IBAN)" version - 1997-10-01, or later revisions. - required: - - IBAN - - properties: - Othr: - allOf: - - $ref: "#/components/schemas/GenericAccountIdentification1" - - description: > - Other + Note on the time format: + 1) beginning / end of calendar day + 00:00:00 = the beginning of a calendar day + 24:00:00 = the end of a calendar day - Unique identification of an account, as assigned by the - account servicer, using an identification scheme. - required: - - Othr + 2) fractions of second in time format + 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 + 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' + Max140Text: + title: Max140Text + description: | + Specifies a character string with a maximum length of 140 characters. + type: string + minLength: 1 + maxLength: 140 + example: 12345 + AddressType2Code: + description: | + AddressType2Code + Specifies the type of address. + ADDR Address + PBOX PostBox + HOME Home + BIZZ Business + MLTO MailingTo + DLVY Delivery + enum: + - ADDR + - PBOX + - HOME + - BIZZ + - MLTO + - DLVY + type: string + example: ADDR + Exact4AlphaNumericText: + title: Exact4AlphaNumericText + description: | + Specifies an alphanumeric string with a length of 4 characters. + type: string + pattern: ^[a-zA-Z0-9]{4}$ + example: 1234 + GenericIdentification30: + title: GenericIdentification30 + type: object + description: | + Generic scheme identification for a party. + properties: + Id: + allOf: + - $ref: '#/components/schemas/Exact4AlphaNumericText' + - description: | + Identification + Proprietary information, often a code, issued by the data source scheme issuer. + Issr: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Issuer + Entity that assigns the identification. + SchmeNm: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + SchemeName + Short textual description of the scheme. + required: + - Id + - Issr example: - IBAN: BE71096123456769 - AccountSchemeName1Choice: - title: AccountSchemeName1Choice + Id: 1234 + Issr: BIC + SchmeNm: BICFI + AddressType3Choice: + title: AddressType3Choice type: object description: | - Sets of elements to identify a name of the identification scheme. + Choice of formats for the type of address. anyOf: - properties: Cd: allOf: - - $ref: "#/components/schemas/ExternalAccountIdentification1Code" - - description: > + - $ref: '#/components/schemas/AddressType2Code' + - description: | Code - - Name of the identification scheme, in a coded form as - published in an external list. + Type of address expressed as a code. required: - Cd - properties: Prtry: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/GenericIdentification30' - description: | Proprietary - Name of the identification scheme, in a free text form. + Type of address expressed as a proprietary code. required: - Prtry example: - Cd: 1111 - ActiveCurrencyAndAmount: - 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. + Cd: ADDR + Max70Text: + title: Max70Text + description: | + Specifies a character string with a maximum length of 70 characters. + type: string + minLength: 1 + maxLength: 70 + example: 1.2345678901234567e+99 + Max16Text: + title: Max16Text + description: | + Specifies a character string with a maximum length of 16 characters. + type: string + minLength: 1 + maxLength: 16 + example: 1234567890123456 + CountryCode: + title: CountryCode + type: string + pattern: ^[A-Z]{2,2}$ + example: US + description: | + Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). + PostalAddress24: + title: PostalAddress24 + type: object + description: | + Information that locates and identifies a specific address, as defined by postal services. properties: - ActiveCurrencyAndAmount: + AdrTp: allOf: - - $ref: "#/components/schemas/ActiveCurrencyAndAmount_SimpleType" - Ccy: + - $ref: '#/components/schemas/AddressType3Choice' + - description: Type of address, as defined by the postal services. + Dept: + allOf: + - $ref: '#/components/schemas/Max70Text' + - description: Name of a department within an organization. + SubDept: + allOf: + - $ref: '#/components/schemas/Max70Text' + - description: Name of a sub-department within a department. + StrtNm: + allOf: + - $ref: '#/components/schemas/Max70Text' + - description: Name of the street or thoroughfare. + BldgNb: + allOf: + - $ref: '#/components/schemas/Max16Text' + - description: Number that identifies a building on the street. + BldgNm: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: Name of the building, if applicable. + Flr: + allOf: + - $ref: '#/components/schemas/Max70Text' + - description: Floor number or identifier within a building. + PstBx: + allOf: + - $ref: '#/components/schemas/Max16Text' + - description: Post office box number. + Room: + allOf: + - $ref: '#/components/schemas/Max70Text' + - description: Room number or identifier within a building. + PstCd: + allOf: + - $ref: '#/components/schemas/Max16Text' + - description: Postal code or ZIP code. + TwnNm: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: Name of the town or city. + TwnLctnNm: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: Name of the location within a town or city. + DstrctNm: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: Name of the district or region. + CtrySubDvsn: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: Name of the country subdivision, such as a state or province. + Ctry: + allOf: + - $ref: '#/components/schemas/CountryCode' + - description: Country code, as defined by ISO 3166-1 alpha-2. + AdrLine: + allOf: + - $ref: '#/components/schemas/Max70Text' + - description: Free-form text line for the address. + example: + AdrTp: ADDR + Dept: Dept + SubDept: SubDept + StrtNm: StrtNm + BldgNb: BldgNb + BldgNm: BldgNm + Flr: Flr + PstBx: PstBx + Room: Room + PstCd: PstCd + TwnNm: TwnNm + TwnLctnNm: TwnLctnNm + DstrctNm: DstrctNm + CtrySubDvsn: CtrySubDvsn + Ctry: Ctry + AdrLine: AdrLine + AnyBICDec2014Identifier: + title: AnyBICDec2014Identifier + type: string + description: | + AnyBICDec2014Identifier + Code allocated to a financial or non-financial institution by the + ISO 9362 Registration Authority, as described in ISO 9362: 2014 + - "Banking - Banking telecommunication messages - Business identifier code (BIC)". + pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$ + example: J5BMVH7D + 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})$ + type: string + pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$ + example: 529900T8BM49AURSDO55 + ExternalOrganisationIdentification1Code: + title: ExternalOrganisationIdentification1Code + description: Specifies the external organisation identification code. + type: string + minLength: 1 + maxLength: 4 + example: 1234 + OrganisationIdentificationSchemeName1Choice: + title: OrganisationIdentificationSchemeName1Choice + description: | + Choice of format for the organisation identification. + type: object + properties: + Cd: allOf: - - $ref: "#/components/schemas/ActiveCurrencyCode" + - $ref: '#/components/schemas/ExternalOrganisationIdentification1Code' - description: | - Currency - Identification of the currency in which the account is held. + Code + Name of the identification scheme, in a coded form as published in an external list. + Prtry: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Proprietary + Name of the identification scheme, in a free text form. + anyOf: + - properties: + Cd: {} + - properties: + Prtry: {} + example: + Cd: BIC + GenericOrganisationIdentification1: + title: GenericOrganisationIdentification1 + type: object + description: | + Information that locates and identifies an organisation. + properties: + Id: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution. + SchmeNm: + allOf: + - $ref: '#/components/schemas/OrganisationIdentificationSchemeName1Choice' + - description: | + SchemeName + Name of the identification scheme. + Issr: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Issuer + Entity that assigns the identification. required: - - ActiveCurrencyAndAmount - - Ccy + - Id example: - ActiveCurrencyAndAmount: 123.45 - Ccy: USD - ActiveCurrencyAndAmount_SimpleType: - title: ActiveCurrencyAndAmount_SimpleType + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC + OrganisationIdentification29: + title: OrganisationIdentification29 + description: | + Unique and unambiguous way to identify an organisation. + type: object + properties: + AnyBIC: + allOf: + - $ref: '#/components/schemas/AnyBICDec2014Identifier' + - description: | + AnyBIC + Business identification code of the organisation. + LEI: + allOf: + - $ref: '#/components/schemas/LEIIdentifier' + - description: | + LEI + Legal entity identification as an alternate identification for a party. + Othr: + allOf: + - $ref: '#/components/schemas/GenericOrganisationIdentification1' + - description: | + Other + Unique identification of an organisation, as assigned by an institution, using an identification scheme. + example: + AnyBIC: BICFI + LEI: 529900T8BM49AURSDO55 + Othr: + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC + 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. type: string - pattern: >- - ^(?!0\d)(\d{1,18}|\d{1,17}.\d{1}|\d{1,16}.\d{1,2}|\d{1,15}.\d{1,3}|\d{1,14}.\d{1,4}|\d{1,13}.\d{1,5})$ - example: 123.45 - ActiveCurrencyCode: - title: ActiveCurrencyCode + format: date + example: '2013-03-07' + DateAndPlaceOfBirth1: + title: DateAndPlaceOfBirth1 + description: | + Details about date and place of birth of a person. + type: object + properties: + BirthDt: + allOf: + - $ref: '#/components/schemas/ISODate' + - description: | + BirthDate + Date on which a person was born. + PrvcOfBirth: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + ProvinceOfBirth + Province where a person was born. + CityOfBirth: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + CityOfBirth + City where a person was born. + CtryOfBirth: + allOf: + - $ref: '#/components/schemas/CountryCode' + - description: | + CountryOfBirth + Country where a person was born. + required: + - BirthDt + - CityOfBirth + - CtryOfBirth + example: + BirthDt: '1970-01-01' + PrvcOfBirth: 'ON' + CityOfBirth: Ottawa + CtryOfBirth: CA + ExternalPersonIdentification1Code: + title: ExternalPersonIdentification1Code + description: Specifies the external person identification code. type: string - description: >- - A code allocated to a currency by a Maintenance Agency under an - international identification scheme as described in the latest edition - of the international standard ISO 4217 "Codes for the representation of - currencies and funds". - - NOTE: This has been modified away from the original ISO20022 pattern to - enums. - example: USD - minLength: 3 - maxLength: 3 - enum: - - AED - - AFN - - ALL - - AMD - - ANG - - AOA - - ARS - - AUD - - AWG - - AZN - - BAM - - BBD - - BDT - - BGN - - BHD - - BIF - - BMD - - BND - - BOB - - BRL - - BSD - - BTN - - BWP - - BYN - - BZD - - CAD - - CDF - - CHF - - CLP - - CNY - - COP - - CRC - - CUC - - CUP - - CVE - - CZK - - DJF - - DKK - - DOP - - DZD - - EGP - - ERN - - ETB - - EUR - - FJD - - FKP - - GBP - - GEL - - GGP - - GHS - - GIP - - GMD - - GNF - - GTQ - - GYD - - HKD - - HNL - - HRK - - HTG - - HUF - - IDR - - ILS - - IMP - - INR - - IQD - - IRR - - ISK - - JEP - - JMD - - JOD - - JPY - - KES - - KGS - - KHR - - KMF - - KPW - - KRW - - KWD - - KYD - - KZT - - LAK - - LBP - - LKR - - LRD - - LSL - - LYD - - MAD - - MDL - - MGA - - MKD - - MMK - - MNT - - MOP - - MRO - - MUR - - MVR - - MWK - - MXN - - MYR - - MZN - - NAD - - NGN - - NIO - - NOK - - NPR - - NZD - - OMR - - PAB - - PEN - - PGK - - PHP - - PKR - - PLN - - PYG - - QAR - - RON - - RSD - - RUB - - RWF - - SAR - - SBD - - SCR - - SDG - - SEK - - SGD - - SHP - - SLL - - SOS - - SPL - - SRD - - STD - - SVC - - SYP - - SZL - - THB - - TJS - - TMT - - TND - - TOP - - TRY - - TTD - - TVD - - TWD - - TZS - - UAH - - UGX - - USD - - UYU - - UZS - - VEF - - VND - - VUV - - WST - - XAF - - XCD - - XDR - - XOF - - XPF - - XTS - - XXX - - YER - - ZAR - - ZMW - - ZWD - ActiveOrHistoricCurrencyAndAmount: - title: ActiveOrHistoricCurrencyAndAmount + minLength: 1 + maxLength: 4 + example: 1234 + PersonIdentificationSchemeName1Choice: + title: PersonIdentificationSchemeName1Choice + description: | + Sets of elements to identify a name of the identification scheme. + type: object + anyOf: + - properties: + Cd: + allOf: + - $ref: '#/components/schemas/ExternalPersonIdentification1Code' + - description: | + Code + Name of the identification scheme, in a coded form as published in an external list. + required: + - Cd + - properties: + Prtry: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Proprietary + Name of the identification scheme, in a free text form. + required: + - Prtry + example: + Cd: CCPT + GenericPersonIdentification1: + title: GenericPersonIdentification1 type: object - description: > - A number of monetary units specified in an active or a historic currency - where the unit of currency is explicit and compliant with ISO 4217. + description: | + GenericPersonIdentification1 + Information that locates and identifies a specific person. properties: - ActiveOrHistoricCurrencyAndAmount: + Id: allOf: - - $ref: >- - #/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType - - description: > - Amount of money to be moved between the debtor and creditor, - before deduction of charges, expressed in the currency as - ordered by the initiating party. - Ccy: + - $ref: '#/components/schemas/Max35Text' + - description: | + Identification + Unique and unambiguous identification of a person. + SchmeNm: allOf: - - $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode" + - $ref: '#/components/schemas/PersonIdentificationSchemeName1Choice' - description: | - Currency - Identification of the currency in which the account is held. + SchemeName + Name of the identification scheme. + Issr: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Issuer + Entity that assigns the identification. required: - - ActiveOrHistoricCurrencyAndAmount - - Ccy + - Id example: - ActiveOrHistoricCurrencyAndAmount: 123.45 - Ccy: USD - ActiveOrHistoricCurrencyAndAmount_SimpleType: - title: ActiveOrHistoricCurrencyAndAmount_SimpleType - type: string - example: 123.45 - pattern: >- - ^(?!0\d)(\d{1,18}|\d{1,17}.\d{1}|\d{1,16}.\d{1,2}|\d{1,15}.\d{1,3}|\d{1,14}.\d{1,4}|\d{1,13}.\d{1,5})$ - ActiveOrHistoricCurrencyCode: - title: ActiveOrHistoricCurrencyCode - type: string - description: > - A code allocated to a currency by a Maintenance Agency under an - international identification scheme, as described in the latest edition - of the international standard ISO 4217 "Codes for the representation of - currencies and funds". + Id: 123 + SchmeNm: + Cd: DRLC + Issr: BIC + PersonIdentification13: + title: PersonIdentification13 + description: | + Unique and unambiguous way to identify a person. + type: object + properties: + DtAndPlcOfBirth: + allOf: + - $ref: '#/components/schemas/DateAndPlaceOfBirth1' + - description: | + DateAndPlaceOfBirth + Date and place of birth of a person. + Othr: + allOf: + - $ref: '#/components/schemas/GenericPersonIdentification1' + - description: | + Other + Unique identification of a person, as assigned by an institution, using an identification scheme. + example: + DtAndPlcOfBirth: + Dt: '2018-01-01' + CityOfBirth: City + Othr: + Id: 123 + SchmeNm: + Cd: CUST + Prtry: 1 + Party38Choice: + title: Party38Choice + description: | + Nature or use of the account. + type: object + anyOf: + - properties: + OrgId: + allOf: + - $ref: '#/components/schemas/OrganisationIdentification29' + - description: | + Organisation + Unique and unambiguous way to identify an organisation. + required: + - OrgId + - properties: + PrvtId: + allOf: + - $ref: '#/components/schemas/PersonIdentification13' + - description: | + PrivateIdentification + Unique and unambiguous identification of a person, for example a passport. + required: + - PrvtId + example: + OrgId: + AnyBIC: BIC + PrvtId: + DtAndPlcOfBirth: + Dt: '2018-01-01' + CityOfBirth: City + NamePrefix2Code: + description: | + Specifies the terms used to formally address a person. - NOTE: This has been modified away from the original ISO20022 pattern to - enums. - example: USD - minLength: 3 - maxLength: 3 - enum: - - AED - - AFN - - ALL - - AMD - - ANG - - AOA - - ARS - - AUD - - AWG - - AZN - - BAM - - BBD - - BDT - - BGN - - BHD - - BIF - - BMD - - BND - - BOB - - BRL - - BSD - - BTN - - BWP - - BYN - - BZD - - CAD - - CDF - - CHF - - CLP - - CNY - - COP - - CRC - - CUC - - CUP - - CVE - - CZK - - DJF - - DKK - - DOP - - DZD - - EGP - - ERN - - ETB - - EUR - - FJD - - FKP - - GBP - - GEL - - GGP - - GHS - - GIP - - GMD - - GNF - - GTQ - - GYD - - HKD - - HNL - - HRK - - HTG - - HUF - - IDR - - ILS - - IMP - - INR - - IQD - - IRR - - ISK - - JEP - - JMD - - JOD - - JPY - - KES - - KGS - - KHR - - KMF - - KPW - - KRW - - KWD - - KYD - - KZT - - LAK - - LBP - - LKR - - LRD - - LSL - - LYD - - MAD - - MDL - - MGA - - MKD - - MMK - - MNT - - MOP - - MRO - - MUR - - MVR - - MWK - - MXN - - MYR - - MZN - - NAD - - NGN - - NIO - - NOK - - NPR - - NZD - - OMR - - PAB - - PEN - - PGK - - PHP - - PKR - - PLN - - PYG - - QAR - - RON - - RSD - - RUB - - RWF - - SAR - - SBD - - SCR - - SDG - - SEK - - SGD - - SHP - - SLL - - SOS - - SPL - - SRD - - STD - - SVC - - SYP - - SZL - - THB - - TJS - - TMT - - TND - - TOP - - TRY - - TTD - - TVD - - TWD - - TZS - - UAH - - UGX - - USD - - UYU - - UZS - - VEF - - VND - - VUV - - WST - - XAF - - XCD - - XDR - - XOF - - XPF - - XTS - - XXX - - YER - - ZAR - - ZMW - - ZWD - AddressType2Code: + DOCT: Doctor or Dr + MADM: Madam + MISS: Miss + MIST: Mistress + MIKS: Mx + enum: + - DOCT + - MADM + - MISS + - MIST + - MIKS + type: string + example: DOCT + PhoneNumber: + title: PhoneNumber + type: string + description: | + Double check this regex. + pattern: ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$ + Max2048Text: + title: Max2048Text + description: | + Specifies a character string with a maximum length of 2048 characters. + type: string + minLength: 1 + maxLength: 2048 + example: 2048 + Max4Text: + title: Max4Text + description: | + Specifies a character string with a maximum length of 4 characters. + type: string + minLength: 1 + maxLength: 4 + example: 1234 + Max128Text: + title: Max128Text + description: | + Specifies a character string with a maximum length of 128 characters. + type: string + minLength: 1 + maxLength: 128 + example: 12345 + OtherContact1: + title: OtherContact1 + description: | + Communication device number or electronic address used for communication. + type: object + properties: + ChanlTp: + allOf: + - $ref: '#/components/schemas/Max4Text' + - description: | + ChannelType + Method used to contact the financial institution's contact for the specific tax region. + Id: + allOf: + - $ref: '#/components/schemas/Max128Text' + - description: | + Identifier + Communication value such as phone number or email address. + required: + - ChanlTp + example: + ChanlTp: PHON + Id: 1234567890 + PreferredContactMethod1Code: + title: PreferredContactMethod1Code + description: | + Preferred method used to reach the individual contact within an organisation. + + LETT: Letter + MAIL: Email + PHON: Phone + FAXX: Fax + CELL: Mobile phone + type: string + enum: + - LETT + - MAIL + - PHON + - FAXX + - CELL + example: CELL + Contact4: + title: Contact4 + description: | + Specifies the details of the contact person. + type: object + properties: + NmPrfx: + allOf: + - $ref: '#/components/schemas/NamePrefix2Code' + - description: | + NamePrefix + Name prefix to be used before the name of the person. + Nm: + allOf: + - $ref: '#/components/schemas/Max140Text' + - description: | + Name + Name by which a party is known and which is usually used to identify that party. + PhneNb: + allOf: + - $ref: '#/components/schemas/PhoneNumber' + - description: | + PhoneNumber + Collection of information that identifies a phone number, as defined by telecom services. + MobNb: + allOf: + - $ref: '#/components/schemas/PhoneNumber' + - description: | + MobilePhoneNumber + Collection of information that identifies a mobile phone number, as defined by telecom services. + FaxNb: + allOf: + - $ref: '#/components/schemas/PhoneNumber' + - description: | + FaxNumber + Collection of information that identifies a fax number, as defined by telecom services. + EmailAdr: + allOf: + - $ref: '#/components/schemas/Max2048Text' + - description: | + EmailAddress + Address for electronic mail (e-mail). + EmailPurp: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + EmailPurpose + Purpose for which an email address may be used. + JobTitl: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + JobTitle + Title of the function. + Rspnsblty: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Responsibility + Role of a person in an organisation. + Dept: + allOf: + - $ref: '#/components/schemas/Max70Text' + - description: | + Department + Identification of a division of a large organisation or building. + Othr: + allOf: + - $ref: '#/components/schemas/OtherContact1' + - description: | + Other + Contact details in another form. + PrefrdMtd: + allOf: + - $ref: '#/components/schemas/PreferredContactMethod1Code' + - description: | + PreferredMethod + Preferred method used to reach the contact. + example: + NmPrfx: Mr + Nm: John Doe + PhneNb: +123-123-321 + MobNb: +123-123-321 + FaxNb: +123-123-321 + EmailAdr: example@example.com + PartyIdentification135: + title: PartyIdentification135 + description: | + Specifies the identification of a person or an organisation. + type: object + properties: + Nm: + allOf: + - $ref: '#/components/schemas/Max140Text' + - description: | + Name + Name by which a party is known and which is usually used to identify that party. + PstlAdr: + allOf: + - $ref: '#/components/schemas/PostalAddress24' + - description: | + PostalAddress + Information that locates and identifies a specific address, as defined by postal services. + Id: + allOf: + - $ref: '#/components/schemas/Party38Choice' + - description: | + Identification + Unique and unambiguous way to identify an organisation. + CtryOfRes: + allOf: + - $ref: '#/components/schemas/CountryCode' + - description: | + CountryOfResidence + Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed. + CtctDtls: + allOf: + - $ref: '#/components/schemas/Contact4' + - description: | + ContactDetails + Set of elements used to indicate how to contact the party. + 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 + BICFIDec2014Identifier: + title: BICFIDec2014Identifier + type: string description: | - AddressType2Code - Specifies the type of address. - ADDR Address - PBOX PostBox - HOME Home - BIZZ Business - MLTO MailingTo - DLVY Delivery - enum: - - ADDR - - PBOX - - HOME - - BIZZ - - MLTO - - DLVY + Code allocated to a financial institution by the ISO 9362 Registration + + Authority as described in ISO 9362: 2014 + + - "Banking - Banking telecommunication messages - Business identifier code (BIC)". + pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$ + example: J5BMVH7D + ExternalClearingSystemIdentification1Code: + title: ExternalClearingSystemIdentification1Code + description: | + Specifies the external clearing system identification code. type: string - example: ADDR - AddressType3Choice: - title: AddressType3Choice - type: object + minLength: 1 + maxLength: 5 + example: 12345 + ClearingSystemIdentification2Choice: + title: ClearingSystemIdentification2Choice description: | - Choice of formats for the type of address. + Specifies the clearing system identification. + type: object anyOf: - properties: Cd: allOf: - - $ref: "#/components/schemas/AddressType2Code" + - $ref: '#/components/schemas/ExternalClearingSystemIdentification1Code' - description: | Code - Type of address expressed as a code. + Clearing system identification code, as published in an external list. required: - Cd - properties: Prtry: allOf: - - $ref: "#/components/schemas/GenericIdentification30" + - $ref: '#/components/schemas/Max35Text' - description: | Proprietary - Type of address expressed as a proprietary code. + Proprietary identification of the clearing system. required: - Prtry example: - Cd: ADDR - AmountTypeEnum: - title: AmountTypeEnum - description: | - NOTE: This pattern is not the original ISO20022 specification. - This represents the enum values when mapping to and from FSPIOP specification. - type: string - enum: - - SEND - - RECEIVE - example: SEND - AnyBICDec2014Identifier: - title: AnyBICDec2014Identifier - type: string - description: > - AnyBICDec2014Identifier - - Code allocated to a financial or non-financial institution by the - - ISO 9362 Registration Authority, as described in ISO 9362: 2014 - - - "Banking - Banking telecommunication messages - Business identifier - code (BIC)". - pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$ - example: J5BMVH7D - BICFIDec2014Identifier: - title: BICFIDec2014Identifier - type: string - description: > - Code allocated to a financial institution by the ISO 9362 Registration - - - Authority as described in ISO 9362: 2014 - - - - "Banking - Banking telecommunication messages - Business identifier - code (BIC)". - pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$ - example: J5BMVH7D - BaseOneRate: - title: BaseOneRate - type: string + Cd: CHIPS + ClearingSystemMemberIdentification2: + title: ClearingSystemMemberIdentification2 description: | - Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%. - example: 0.7 - pattern: >- - ^(?!0\d)(\d{1,11}|\d{1,10}.\d{1}|\d{1,9}.\d{1,2}|\d{1,8}.\d{1,3}|\d{1,7}.\d{1,4}|\d{1,6}.\d{1,5}|\d{1,5}.\d{1,6}|\d{1,4}.\d{1,7}|\d{1,3}.\d{1,8}|\d{1,2}.\d{1,9}|\d{1}.\d{1,10})$ - BranchAndFinancialInstitutionIdentification6: - title: BranchAndFinancialInstitutionIdentification6 + Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system. type: object - description: > - Unique and unambiguous identification of a financial institution or a - branch of a financial institution. properties: - FinInstnId: + ClrSysId: allOf: - - $ref: "#/components/schemas/FinancialInstitutionIdentification18" - - description: > - FinancialInstitutionIdentification - - Unique and unambiguous identification of a financial - institution, as assigned under an internationally recognised or - proprietary identification scheme. - BrnchId: + - $ref: '#/components/schemas/ClearingSystemIdentification2Choice' + - description: | + ClearingSystemIdentification + Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed. + MmbId: allOf: - - $ref: "#/components/schemas/BranchData3" - - description: > - BranchIdentification - - Definition: Identifies a specific branch of a financial - institution. - - Usage: This component should be used in case the identification - information in the financial institution component does not - provide identification up to branch level. + - $ref: '#/components/schemas/Max35Text' + - description: | + MemberIdentification + Identification of a member of a clearing system. required: - - FinInstnId + - MmbId example: - FinInstnId: - BICFI: J5BMVH7D - BrnchId: - Id: 123 - Nm: Name - PstlAdr: - AdrTp: ADDR - Dept: Department - SubDept: Sub department - StrtNm: Street name - BldgNb: Building number - PstCd: Post code - TwnNm: Town name - CtrySubDvsn: Country subdivision - Ctry: Country - AdrLine: Address line - BranchAndFinancialInstitutionIdentification8: - title: BranchAndFinancialInstitutionIdentification8 + ClrSysId: + Cd: CHQB + MmbId: 123456789 + ExternalFinancialInstitutionIdentification1Code: + title: ExternalFinancialInstitutionIdentification1Code + description: Specifies the external financial institution identification code. + type: string + minLength: 1 + maxLength: 4 + example: 1234 + FinancialIdentificationSchemeName1Choice: + title: FinancialIdentificationSchemeName1Choice + type: object + description: | + Specifies the name of the identification scheme. + anyOf: + - properties: + Cd: + allOf: + - $ref: '#/components/schemas/ExternalFinancialInstitutionIdentification1Code' + - description: | + Code + Name of the identification scheme, in a coded form as published in an external list. + required: + - Cd + - properties: + Prtry: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Proprietary + Name of the identification scheme, in a free text form. + required: + - Prtry + example: + Cd: BIC + GenericFinancialIdentification1: + title: GenericFinancialIdentification1 type: object - description: > - Unique and unambiguous identification of a financial institution or a - branch of a financial institution. + description: | + GenericFinancialIdentification + Unique and unambiguous identification of a person, which is used to refer to a person in a financial context. properties: - FinInstnId: + Id: allOf: - - $ref: "#/components/schemas/FinancialInstitutionIdentification23" - - description: > - FinancialInstitutionIdentification - - Unique and unambiguous identification of a financial institution - or a branch of a financial institution. - BrnchId: + - $ref: '#/components/schemas/Max35Text' + - description: | + Identification + Unique and unambiguous identification of a person. + SchmeNm: allOf: - - $ref: "#/components/schemas/BranchData5" + - $ref: '#/components/schemas/FinancialIdentificationSchemeName1Choice' - description: | - BranchIdentification - Identifies a specific branch of a financial institution. + SchemeName + Name of the identification scheme. + Issr: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Issuer + Entity that assigns the identification. required: - - FinInstnId + - Id example: - FinInstnId: - BICFI: J5BMVH7D - BrnchId: - Id: 123 - Nm: Name - PstlAdr: - AdrTp: ADDR - Dept: Department - SubDept: Sub department - StrtNm: Street name - BldgNb: Building number - PstCd: Post code - TwnNm: Town name - CtrySubDvsn: Country subdivision - Ctry: Country - AdrLine: Address line - BranchData3: - title: BranchData3 + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + FinancialInstitutionIdentification18: + title: FinancialInstitutionIdentification18 type: object - description: > - Information that locates and identifies a specific branch of a financial - institution. + description: | + Information used to identify a financial institution. properties: - Id: + BICFI: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - Identification - - Unique and unambiguous identification of a branch of a financial - institution. + - $ref: '#/components/schemas/BICFIDec2014Identifier' + - description: | + BICFI + Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)" + ClrSysMmbId: + allOf: + - $ref: '#/components/schemas/ClearingSystemMemberIdentification2' + - description: | + ClearingSystemMemberIdentification + Information used to identify a member within a clearing system LEI: allOf: - - $ref: "#/components/schemas/LEIIdentifier" - - description: > - Legal Entity Identifier - - Legal entity identification for the branch of the financial - institution. + - $ref: '#/components/schemas/LEIIdentifier' + - description: | + LEI + Legal entity identifier of the financial institution. Nm: allOf: - - $ref: "#/components/schemas/Max140Text" - - description: > + - $ref: '#/components/schemas/Max140Text' + - description: | Name - - Name by which an agent is known and which is usually used to - identify that agent. + Name by which an agent is known and which is usually used to identify that agent PstlAdr: allOf: - - $ref: "#/components/schemas/PostalAddress24" - - description: > - Postal Address - - Information that locates and identifies a specific address, as - defined by postal services. + - $ref: '#/components/schemas/PostalAddress24' + - description: | + PostalAddress + Information that locates and identifies a specific address, as defined by postal services. + Othr: + allOf: + - $ref: '#/components/schemas/GenericFinancialIdentification1' + - description: | + Other + Unique identification of an agent, as assigned by an institution, using an identification scheme. + required: + - Othr example: - Id: 123 + BICFI: J5BMVH7D + ClrSysMmbId: + ClrSysId: 1234 + MmbId: 123 + LEI: 123 Nm: Name PstlAdr: AdrTp: ADDR @@ -2058,48 +2218,44 @@ components: CtrySubDvsn: Country subdivision Ctry: Country AdrLine: Address line - BranchData5: - title: BranchData5 - description: > - Information that locates and identifies a specific branch of a financial - institution. + Othr: + Id: 123 + SchmeNm: + Cd: 123 + Prtry: 123 + Issr: 123 + BranchData3: + title: BranchData3 type: object + description: | + Information that locates and identifies a specific branch of a financial institution. properties: Id: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > + - $ref: '#/components/schemas/Max35Text' + - description: | Identification - - Unique and unambiguous identification of a branch of a financial - institution. + Unique and unambiguous identification of a branch of a financial institution. LEI: allOf: - - $ref: "#/components/schemas/LEIIdentifier" - - description: > - LEI - - Legal entity identification for the branch of the financial - institution. + - $ref: '#/components/schemas/LEIIdentifier' + - description: | + Legal Entity Identifier + Legal entity identification for the branch of the financial institution. Nm: allOf: - - $ref: "#/components/schemas/Max140Text" - - description: > + - $ref: '#/components/schemas/Max140Text' + - description: | Name - - Name by which an agent is known and which is usually used to - identify that agent. + Name by which an agent is known and which is usually used to identify that agent. PstlAdr: allOf: - - $ref: "#/components/schemas/PostalAddress27" - - description: > - PostalAddress - - Information that locates and identifies a specific address, as - defined by postal services. + - $ref: '#/components/schemas/PostalAddress24' + - description: | + Postal Address + Information that locates and identifies a specific address, as defined by postal services. example: Id: 123 - LEI: 123 Nm: Name PstlAdr: AdrTp: ADDR @@ -2107,2048 +2263,2238 @@ components: SubDept: Sub department StrtNm: Street name BldgNb: Building number - CashAccount40: - title: CashAccount40 + PstCd: Post code + TwnNm: Town name + CtrySubDvsn: Country subdivision + Ctry: Country + AdrLine: Address line + BranchAndFinancialInstitutionIdentification6: + title: BranchAndFinancialInstitutionIdentification6 type: object description: | - Provides the details to identify an account. + Unique and unambiguous identification of a financial institution or a branch of a financial institution. properties: - Id: + FinInstnId: allOf: - - $ref: "#/components/schemas/AccountIdentification4Choice" - - description: > - Identification - - Unique and unambiguous identification for the account between - the account owner and the account servicer. - Tp: + - $ref: '#/components/schemas/FinancialInstitutionIdentification18' + - description: | + FinancialInstitutionIdentification + Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. + BrnchId: allOf: - - $ref: "#/components/schemas/CashAccountType2Choice" + - $ref: '#/components/schemas/BranchData3' - description: | - Type - Specifies the nature, or use of the account. - Ccy: + BranchIdentification + Definition: Identifies a specific branch of a financial institution. + Usage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level. + 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 + Party40Choice: + title: Party40Choice + description: | + Identification of a person, an organisation or a financial institution. + type: object + anyOf: + - properties: + Pty: + allOf: + - $ref: '#/components/schemas/PartyIdentification135' + - description: | + Party + Identification of a person or an organisation. + required: + - Pty + - properties: + Agt: + allOf: + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6' + - description: | + Agent + Identification of a financial institution. + 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 + IdentificationAssignment3: + title: IdentificationAssignment3 + type: object + description: | + IdentificationAssignment + Information that unambiguously identifies a message, as assigned by the assignor to the assignee. + properties: + MsgId: allOf: - - $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode" - - description: > - Currency - - Identification of the currency in which the account is held. - - Usage: 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. - Nm: + - $ref: '#/components/schemas/Max35Text' + - description: | + MessageIdentification + Unique identification, as assigned by the assigner, to unambiguously identify the message. + CreDtTm: allOf: - - $ref: "#/components/schemas/Max70Text" - - description: > - Name - - Name of the account, as assigned by the account servicing - institution, in agreement with the account owner in order to - provide an additional means of identification of the account. - - Usage: 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. - Prxy: + - $ref: '#/components/schemas/ISODateTime' + - description: | + CreationDateTime + Date and time at which the identification assignment was created. + Assgnr: allOf: - - $ref: "#/components/schemas/ProxyAccountIdentification1" - - description: > - Proxy - - Specifies an alternate assumed name for the identification of - the account. + - $ref: '#/components/schemas/Party40Choice' + - description: | + Assignor + Party that assigns the identification assignment to another party. This is also the sender of the message. + Assgne: + allOf: + - $ref: '#/components/schemas/Party40Choice' + - description: | + Assignee + Party that the identification assignment is assigned to. This is also the receiver of the message. + required: + - MsgId + - CreDtTm + - Assgnr + - Assgne example: - Id: - IBAN: BE71096123456769 - Tp: - Cd: CACC - Ccy: EUR - Nm: My account - Prxy: - Id: 12345 - CashAccountType2Choice: - title: CashAccountType2Choice + 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 + IdentificationVerificationIndicator: + title: IdentificationVerificationIndicator + type: boolean + example: true description: | - Specifies the nature, or use of the account. + Definition: Identifies whether the party and/or account information received is correct. + + • Meaning When True: Indicates that the identification information received is correct. + • Meaning When False: Indicates that the identification information received is incorrect + ExternalVerificationReason1Code: + title: ExternalVerificationReason1Code + description: Specifies the external verification reason code. + type: string + minLength: 1 + maxLength: 4 + example: 1234 + VerificationReason1Choice: + title: VerificationReason1Choice type: object + description: | + Choice of format for the verification reason. + Only one, between the coded and the proprietary, can be chosen. anyOf: - properties: Cd: allOf: - - $ref: "#/components/schemas/ExternalCashAccountType1Code" + - $ref: '#/components/schemas/ExternalVerificationReason1Code' - description: | Code - Account type, in a coded form. + Reason why the verified identification information is incorrect, as published in an external reason code list. required: - Cd - properties: Prtry: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/Max35Text' - description: | Proprietary - Nature or use of the account in a proprietary form. + Reason why the verified identification information is incorrect, in a free text form. required: - Prtry example: - Cd: CACC - CategoryPurpose1Choice: - title: CategoryPurpose1Choice - description: > - Contains details about high level purpose of the mandate based on a set - of pre-defined categories. + Cd: AGNT + 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 - + International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard. + type: string + example: FR1420041010050500013M02606 + pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ + Max34Text: + title: Max34Text + description: | + Specifies a character string with a maximum length of 34 characters. + type: string + minLength: 1 + maxLength: 34 + example: 1.2345678901234568e+33 + 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. + type: string + minLength: 1 + maxLength: 4 + example: 1234 + AccountSchemeName1Choice: + title: AccountSchemeName1Choice type: object + description: | + Sets of elements to identify a name of the identification scheme. anyOf: - properties: Cd: allOf: - - $ref: "#/components/schemas/ExternalCategoryPurpose1Code" - - description: > + - $ref: '#/components/schemas/ExternalAccountIdentification1Code' + - description: | Code - - Category purpose, as published in an external category - purpose code list. + Name of the identification scheme, in a coded form as published in an external list. required: - Cd - properties: Prtry: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/Max35Text' - description: | Proprietary - Category purpose, in a proprietary form. + Name of the identification scheme, in a free text form. required: - Prtry example: - Cd: CASH - ChargeBearerType1Code: - title: ChargeBearerType1Code - description: > - Specifies which party(ies) will pay charges due for processing of the - - instruction. - - - DEBT: BorneByDebtor All transaction charges are to be borne by the - debtor. - - CRED: BorneByCreditor All transaction charges are to be borne by the - creditor. - - SHAR: Shared In a credit transfer context, means that transaction - charges on - the sender side are to be borne by the debtor, transaction charges on the receiver side are to - be borne by the creditor. In a direct debit context, means that transaction charges on the sender side - are to be borne by the creditor, transaction charges on the receiver + Cd: 1111 + GenericAccountIdentification1: + title: GenericAccountIdentification1 + type: object + description: | + GenericAccountIdentification + Unique and unambiguous identification of an account, as assigned by the account servicer. + properties: + Id: + allOf: + - $ref: '#/components/schemas/Max34Text' + - description: | + Identification + Identification assigned by an institution. + SchmeNm: + allOf: + - $ref: '#/components/schemas/AccountSchemeName1Choice' + - description: | + SchemeName + Name of the identification scheme. + Issr: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Issuer + Entity that assigns the identification. + required: + - Id + example: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + AccountIdentification4Choice: + title: AccountIdentification4Choice + type: object + description: | + Specifies the unique identification of an account as assigned by the account servicer. + anyOf: + - properties: + IBAN: + allOf: + - $ref: '#/components/schemas/IBAN2007Identifier' + - description: | + IBAN + International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services - International Bank Account Number (IBAN)" version 1997-10-01, or later revisions. + required: + - IBAN + - properties: + Othr: + allOf: + - $ref: '#/components/schemas/GenericAccountIdentification1' + - description: | + Other + Unique identification of an account, as assigned by the account servicer, using an identification scheme. + required: + - Othr + example: + IBAN: BE71096123456769 + 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. type: string - enum: - - DEBT - - CRED - - SHAR - example: DEBT - ChargeType3Choice: - title: ChargeType3Choice + minLength: 1 + maxLength: 4 + example: 1234 + CashAccountType2Choice: + title: CashAccountType2Choice description: | - ChargeType3Choice - Specifies the type of charge. + Specifies the nature, or use of the account. type: object anyOf: - properties: Cd: allOf: - - $ref: "#/components/schemas/ExternalChargeType1Code" + - $ref: '#/components/schemas/ExternalCashAccountType1Code' - description: | Code - Charge type, in a coded form. + Account type, in a coded form. required: - Cd - properties: Prtry: allOf: - - $ref: "#/components/schemas/GenericIdentification3" - - description: > + - $ref: '#/components/schemas/Max35Text' + - description: | Proprietary - - Type of charge in a proprietary form, as defined by the - issuer. + Nature or use of the account in a proprietary form. required: - Prtry example: - Cd: CASH - Charges16: - title: Charges16 + Cd: CACC + ActiveOrHistoricCurrencyCode: + title: ActiveOrHistoricCurrencyCode + type: string description: | - NOTE: Unsure on description. - - Seemingly a generic schema for charges, with an amount, agent, and type. - type: object - properties: - Amt: - allOf: - - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" - - description: | - Amount - Transaction charges to be paid by the charge bearer. - Agt: - allOf: - - $ref: >- - #/components/schemas/BranchAndFinancialInstitutionIdentification8 - - description: > - Agent - - Agent that takes the transaction charges or to which the - transaction charges are due. - Tp: - allOf: - - $ref: "#/components/schemas/ChargeType3Choice" - - description: | - Type - Defines the type of charges. - required: - - Amt - - Agt - example: - Amt: - ActiveOrHistoricCurrencyAndAmount: 123.45 - Ccy: USD - Agt: - BrnchId: - Id: BRANCHID - FinInstnId: - BICFI: BICFI - Tp: - Cd: SHAR - ClearingChannel2Code: - title: ClearingChannel2Code - description: > - Specifies the clearing channel for the routing of the transaction, as - part of - - the payment type identification. - - - RTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time - gross settlement system. - - RTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net - settlement system. - - MPNS: MassPaymentNetSystem Clearing channel is a mass payment net - settlement system. - - BOOK: BookTransfer Payment through internal book transfer. + A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". + NOTE: This has been modified away from the original ISO20022 pattern to enums. + example: USD + minLength: 3 + maxLength: 3 + enum: + - AED + - AFN + - ALL + - AMD + - ANG + - AOA + - ARS + - AUD + - AWG + - AZN + - BAM + - BBD + - BDT + - BGN + - BHD + - BIF + - BMD + - BND + - BOB + - BRL + - BSD + - BTN + - BWP + - BYN + - BZD + - CAD + - CDF + - CHF + - CLP + - CNY + - COP + - CRC + - CUC + - CUP + - CVE + - CZK + - DJF + - DKK + - DOP + - DZD + - EGP + - ERN + - ETB + - EUR + - FJD + - FKP + - GBP + - GEL + - GGP + - GHS + - GIP + - GMD + - GNF + - GTQ + - GYD + - HKD + - HNL + - HRK + - HTG + - HUF + - IDR + - ILS + - IMP + - INR + - IQD + - IRR + - ISK + - JEP + - JMD + - JOD + - JPY + - KES + - KGS + - KHR + - KMF + - KPW + - KRW + - KWD + - KYD + - KZT + - LAK + - LBP + - LKR + - LRD + - LSL + - LYD + - MAD + - MDL + - MGA + - MKD + - MMK + - MNT + - MOP + - MRO + - MUR + - MVR + - MWK + - MXN + - MYR + - MZN + - NAD + - NGN + - NIO + - NOK + - NPR + - NZD + - OMR + - PAB + - PEN + - PGK + - PHP + - PKR + - PLN + - PYG + - QAR + - RON + - RSD + - RUB + - RWF + - SAR + - SBD + - SCR + - SDG + - SEK + - SGD + - SHP + - SLL + - SOS + - SPL + - SRD + - STD + - SVC + - SYP + - SZL + - THB + - TJS + - TMT + - TND + - TOP + - TRY + - TTD + - TVD + - TWD + - TZS + - UAH + - UGX + - USD + - UYU + - UZS + - VEF + - VND + - VUV + - WST + - XAF + - XCD + - XDR + - XOF + - XPF + - XTS + - XXX + - YER + - ZAR + - ZMW + - ZWD + ExternalProxyAccountType1Code: + title: ExternalProxyAccountType1Code + description: Specifies the external proxy account type code. type: string - enum: - - RTGS - - RTNS - - MPNS - - BOOK - example: RTGS - ClearingSystemIdentification2Choice: - title: ClearingSystemIdentification2Choice + minLength: 1 + maxLength: 4 + example: 1234 + ProxyAccountType1Choice: + title: ProxyAccountType1Choice description: | - Specifies the clearing system identification. + Specifies the type of the proxy account. type: object anyOf: - properties: Cd: allOf: - - $ref: >- - #/components/schemas/ExternalClearingSystemIdentification1Code - - description: > + - $ref: '#/components/schemas/ExternalProxyAccountType1Code' + - description: | Code - - Clearing system identification code, as published in an - external list. + Proxy account type, in a coded form as published in an external list. required: - Cd - properties: Prtry: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/Max35Text' - description: | Proprietary - Proprietary identification of the clearing system. + Proxy account type, in a proprietary form. required: - Prtry example: - Cd: CHIPS - ClearingSystemMemberIdentification2: - title: ClearingSystemMemberIdentification2 - description: > - Unique identification, as assigned by a clearing system, to - unambiguously identify a member of the clearing system. - type: object - properties: - ClrSysId: - allOf: - - $ref: "#/components/schemas/ClearingSystemIdentification2Choice" - - description: > - ClearingSystemIdentification - - Specification of a pre-agreed offering between clearing agents - or the channel through which the payment instruction is - processed. - MmbId: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: | - MemberIdentification - Identification of a member of a clearing system. - required: - - MmbId - example: - ClrSysId: - Cd: CHQB - MmbId: 123456789 - Contact13: - title: Contact13 + Cd: EMAIL + ProxyAccountIdentification1: + title: ProxyAccountIdentification1 description: | - Specifies the details of the contact person. + Information related to a proxy identification of the account. type: object properties: - NmPrfx: - allOf: - - $ref: "#/components/schemas/NamePrefix2Code" - - description: | - NamePrefix - Specifies the terms used to formally address a person. - Nm: - allOf: - - $ref: "#/components/schemas/Max140Text" - - description: > - Name - - Name by which a party is known and which is usually used to - identify that party. - PhneNb: - allOf: - - $ref: "#/components/schemas/PhoneNumber" - - description: > - PhoneNumber - - Collection of information that identifies a phone number, as - defined by telecom services. - MobNb: - allOf: - - $ref: "#/components/schemas/PhoneNumber" - - description: > - MobilePhoneNumber - - Collection of information that identifies a mobile phone number, - as defined by telecom services. - FaxNb: - allOf: - - $ref: "#/components/schemas/PhoneNumber" - - description: > - FaxNumber - - Collection of information that identifies a fax number, as - defined by telecom services. - URLAdr: - allOf: - - $ref: "#/components/schemas/Max2048Text" - - description: > - URLAddress - - Address for the Universal Resource Locator (URL), for example an - address used over the www (HTTP) service. - EmailAdr: - allOf: - - $ref: "#/components/schemas/Max256Text" - - description: | - EmailAddress - Address for electronic mail (e-mail). - EmailPurp: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: | - EmailPurpose - Purpose for which an email address may be used. - JobTitl: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: | - JobTitle - Title of the function. - Rspnsblty: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: | - Responsibility - Role of a person in an organisation. - Dept: - allOf: - - $ref: "#/components/schemas/Max70Text" - - description: > - Department - - Identification of a division of a large organisation or - building. - Othr: + Tp: allOf: - - $ref: "#/components/schemas/OtherContact1" + - $ref: '#/components/schemas/ProxyAccountType1Choice' - description: | - OtherContact - Contact details in another form. - PrefrdMtd: + Type + Type of the proxy identification. + Id: allOf: - - $ref: "#/components/schemas/PreferredContactMethod2Code" + - $ref: '#/components/schemas/Max2048Text' - description: | - PreferredContactMethod - Preferred method used to reach the contact. + Identification + Identification used to indicate the account identification under another specified name. + required: + - Id example: - NmPrfx: Mr - Nm: John Doe - PhneNb: +123-123-321 - MobNb: +123-123-321 - FaxNb: +123-123-321 - URLAdr: http://www.example.com - EmailAdr: example@example.com - Contact4: - title: Contact4 - description: | - Specifies the details of the contact person. + Tp: + Cd: IBAN + Id: 123 + CashAccount40: + title: CashAccount40 type: object + description: | + Provides the details to identify an account. properties: - NmPrfx: - allOf: - - $ref: "#/components/schemas/NamePrefix2Code" - - description: | - NamePrefix - Name prefix to be used before the name of the person. - Nm: - allOf: - - $ref: "#/components/schemas/Max140Text" - - description: > - Name - - Name by which a party is known and which is usually used to - identify that party. - PhneNb: - allOf: - - $ref: "#/components/schemas/PhoneNumber" - - description: > - PhoneNumber - - Collection of information that identifies a phone number, as - defined by telecom services. - MobNb: - allOf: - - $ref: "#/components/schemas/PhoneNumber" - - description: > - MobilePhoneNumber - - Collection of information that identifies a mobile phone number, - as defined by telecom services. - FaxNb: - allOf: - - $ref: "#/components/schemas/PhoneNumber" - - description: > - FaxNumber - - Collection of information that identifies a fax number, as - defined by telecom services. - EmailAdr: - allOf: - - $ref: "#/components/schemas/Max2048Text" - - description: | - EmailAddress - Address for electronic mail (e-mail). - EmailPurp: + Id: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/AccountIdentification4Choice' - description: | - EmailPurpose - Purpose for which an email address may be used. - JobTitl: + Identification + Unique and unambiguous identification for the account between the account owner and the account servicer. + Tp: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/CashAccountType2Choice' - description: | - JobTitle - Title of the function. - Rspnsblty: + Type + Specifies the nature, or use of the account. + Ccy: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' - description: | - Responsibility - Role of a person in an organisation. - Dept: - allOf: - - $ref: "#/components/schemas/Max70Text" - - description: > - Department - - Identification of a division of a large organisation or - building. - Othr: + Currency + Identification of the currency in which the account is held. + Usage: 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. + Nm: allOf: - - $ref: "#/components/schemas/OtherContact1" + - $ref: '#/components/schemas/Max70Text' - description: | - Other - Contact details in another form. - PrefrdMtd: + Name + Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. + Usage: 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. + Prxy: allOf: - - $ref: "#/components/schemas/PreferredContactMethod1Code" + - $ref: '#/components/schemas/ProxyAccountIdentification1' - description: | - PreferredMethod - Preferred method used to reach the contact. + Proxy + Specifies an alternate assumed name for the identification of the account. example: - NmPrfx: Mr - Nm: John Doe - PhneNb: +123-123-321 - MobNb: +123-123-321 - FaxNb: +123-123-321 - EmailAdr: example@example.com - CountryCode: - title: CountryCode - type: string - pattern: ^[A-Z]{2,2}$ - example: US - description: > - Code to identify a country, a dependency, or another area of particular - geopolitical interest, on the basis of country names obtained from the - United Nations (ISO 3166, Alpha-2 code). - CreditTransferTransaction67: - title: CreditTransferTransaction67 - description: > - Provides further details specific to the individual transaction(s) - included in the message. + Id: + IBAN: BE71096123456769 + Tp: + Cd: CACC + Ccy: EUR + Nm: My account + Prxy: + Id: 12345 + IdentificationInformation4: + title: IdentificationInformation4 type: object + description: | + Information that locates and identifies a specific party or account. properties: - PmtId: - allOf: - - $ref: "#/components/schemas/PaymentIdentification13" - - description: | - PaymentIdentification - Set of elements used to reference a payment instruction. - PmtTpInf: - allOf: - - $ref: "#/components/schemas/PaymentTypeInformation28" - - 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" - - description: > - InterbankSettlementAmount - - Amount of money moved between the instructing agent and the - instructed agent. - 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. - XchgRate: - allOf: - - $ref: "#/components/schemas/BaseOneRate" - - description: > - ExchangeRate - - Factor used to convert an amount from one currency into another. - This reflects the price at which one currency was bought with - another currency. - ChrgBr: - $ref: "#/components/schemas/ChargeBearerType1Code" - ChrgsInf: - allOf: - - $ref: "#/components/schemas/Charges16" - - description: > - ChargesInformation - - Provides information on the charges to be paid by the charge - bearer(s) related to the payment transaction. - Dbtr: - allOf: - - $ref: "#/components/schemas/PartyIdentification272" - - description: | - Debtor - Party that owes an amount of money to the (ultimate) creditor. - DbtrAcct: - allOf: - - $ref: "#/components/schemas/CashAccount40" - - description: > - DebtorAccount - - Unambiguous identification of the account of the debtor to which - a debit entry will be made as a result of the transaction. - DbtrAgt: + Pty: allOf: - - $ref: >- - #/components/schemas/BranchAndFinancialInstitutionIdentification8 + - $ref: '#/components/schemas/PartyIdentification135' - description: | - DebtorAgent - Financial institution servicing an account for the debtor. - CdtrAgt: + Party + Account owner that owes an amount of money or to whom an amount of money is due. + Acct: allOf: - - $ref: >- - #/components/schemas/BranchAndFinancialInstitutionIdentification8 + - $ref: '#/components/schemas/CashAccount40' - description: | - CreditorAgent - Financial institution servicing an account for the creditor. - Cdtr: + Account + Unambiguous identification of the account of a party. + Agt: allOf: - - $ref: "#/components/schemas/PartyIdentification272" + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6' - description: | - Creditor - Party to which an amount of money is due. - CdtrAcct: - allOf: - - $ref: "#/components/schemas/CashAccount40" - - description: > - CreditorAccount - - Unambiguous identification of the account of the creditor to - which a credit entry will be posted as a result of the payment - transaction. - InstrForCdtrAgt: + Agent + Financial institution servicing an account for a party. + required: + - Pty + example: + Pty: + Id: + OrgId: + AnyBIC: + BICFI: BICFI + CtryOfRes: FI + Acct: + Id: + IBAN: FI2112345600000785 + Agt: + FinInstnId: + BICFI: BICFI + VerificationReport4: + title: VerificationReport4 + type: object + description: |- + VerificationReport + Provides information about the verification of party and/or account identification information. + properties: + OrgnlId: allOf: - - $ref: "#/components/schemas/InstructionForCreditorAgent3" - - description: > - InstructionForCreditorAgent - - Set of elements used to provide information on the remittance - advice. - InstrForNxtAgt: + - $ref: '#/components/schemas/Max35Text' + - description: | + OriginalIdentification + Unique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message. + Vrfctn: allOf: - - $ref: "#/components/schemas/InstructionForNextAgent1" - - description: > - InstructionForNextAgent - - Set of elements used to provide information on the remittance - advice. - Purp: + - $ref: '#/components/schemas/IdentificationVerificationIndicator' + - description: | + Verification + Identifies whether the party and/or account information received is correct. Boolean value. + Rsn: allOf: - - $ref: "#/components/schemas/Purpose2Choice" + - $ref: '#/components/schemas/VerificationReason1Choice' - description: | - Purpose - Underlying reason for the payment transaction. - RgltryRptg: + Reason + Specifies the reason why the verified identification information is incorrect. + OrgnlPtyAndAcctId: allOf: - - $ref: "#/components/schemas/RegulatoryReporting3" + - $ref: '#/components/schemas/IdentificationInformation4' - description: | - RegulatoryReporting - Information needed due to regulatory and statutory requirements. - Tax: + OriginalPartyAndAccountIdentification + Provides party and/or account identification information as given in the original message. + UpdtdPtyAndAcctId: allOf: - - $ref: "#/components/schemas/TaxData1" + - $ref: '#/components/schemas/IdentificationInformation4' - description: | - Tax - Provides details on the tax. - VrfctnOfTerms: - $ref: "#/components/schemas/CryptographicLockChoice" + UpdatedPartyAndAccountIdentification + Provides party and/or account identification information. required: - - PmtId - - IntrBkSttlmAmt - - ChrgBr - - Dbtr - - DbtrAgt - - CdtrAgt - - Cdtr + - OrgnlId + - Vrfctn + - UpdtdPtyAndAcctId 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 + OrgnlId: 1.2345678901234568e+33 + Vrfctn: true + OrgnlPtyAndAcctId: + Nm: John Doe PstlAdr: AdrTp: ADDR - BldgNb: BLDGNB - Ctry: CTRY - TwnNm: TWNNM - PstCd: PSTCD - StrtNm: STRTNM - DbtrAcct: + Dept: Dept + SubDept: SubDept + StrtNm: 1234 Elm St + BldgNb: 1234 + PstCd: 12345 + TwnNm: Anytown + CtrySubDvsn: CA + Ctry: US Id: - IBAN: IBAN - DbtrAgt: - BrnchId: - Id: BRANCHID - FinInstnId: - BICFI: BICFI - CdtrAgt: - BrnchId: - Id: BRANCHID - FinInstnId: - BICFI: BICFI - Cdtr: - Nm: NAME + OrgId: + AnyBIC: ABCDUS33 + Othr: + Id: 123456789 + Issr: ABA + UpdtdPtyAndAcctId: + Nm: John Doe PstlAdr: AdrTp: ADDR - BldgNb: BLDGNB - Ctry: CTRY - TwnNm: TWNNM - PstCd: PSTCD - StrtNm: STRTNM - CdtrAcct: + Dept: Dept + SubDept: SubDept + StrtNm: 1234 Elm St + BldgNb: 1234 + PstCd: 12345 + TwnNm: Anytown + CtrySubDvsn: CA + Ctry: US 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. + OrgId: + AnyBIC: ABCDUS33 + Othr: + Id: 123456789 + Issr: ABA + Max350Text: + title: Max350Text + description: | + Specifies a character string with a maximum length of 350 characters. + type: string + minLength: 1 + maxLength: 350 + example: 350 + SupplementaryDataEnvelope1: + title: SupplementaryDataEnvelope1 + description: | + SupplementaryDataEnvelope1 + Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information. + type: object + SupplementaryData1: + title: SupplementaryData1 + description: | + Additional information that cannot be captured in the structured fields and/or any other specific block. + type: object + properties: + PlcAndNm: + allOf: + - $ref: '#/components/schemas/Max350Text' + - description: | + PlaceAndName + Unambiguous reference to the location where the supplementary data must be inserted in the message instance. + Envlp: + allOf: + - $ref: '#/components/schemas/SupplementaryDataEnvelope1' + - description: | + Envelope + Technical element wrapping the supplementary data. + Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information. + required: + - Envlp + example: + PlcAndNm: Additional information + Envlp: + Cd: CH03 + Prtry: Additional information + GetParties_IdentificationVerificationReportV03: + title: GetParties_IdentificationVerificationReportV03 + type: object + properties: + Assgnmt: + allOf: + - $ref: '#/components/schemas/IdentificationAssignment3' + - description: | + Assignment + Identifies the identification assignment. + Rpt: + allOf: + - $ref: '#/components/schemas/VerificationReport4' + - description: | + Report + Information concerning the verification of the identification data for which verification was requested. + SplmtryData: + allOf: + - $ref: '#/components/schemas/SupplementaryData1' + - description: | + SupplementaryData + Additional information that cannot be captured in the structured elements and/or any other specific block. + 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 + VerificationReport4b: + title: VerificationReport4 type: object + description: |- + VerificationReport + Provides information about the verification of party and/or account identification information. properties: - PmtId: - allOf: - - $ref: "#/components/schemas/PaymentIdentification13" - - description: | - PaymentIdentification - Set of elements used to reference a payment instruction. - PmtTpInf: - allOf: - - $ref: "#/components/schemas/PaymentTypeInformation28" - - description: | - PaymentTypeInformation - Set of elements used to further specify the type of transaction. - UndrlygCstmrCdtTrf: + OrgnlId: allOf: - - $ref: "#/components/schemas/UnderlyingCustomerCreditTransfer" + - $ref: '#/components/schemas/Max35Text' - description: | - Underlying Customer Credit Transfer - TBD - IntrBkSttlmAmt: - allOf: - - $ref: "#/components/schemas/ActiveCurrencyAndAmount" - - description: > - InterbankSettlementAmount - - Amount of money moved between the instructing agent and the - instructed agent. - Dbtr: + OriginalIdentification + Unique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message. + Vrfctn: allOf: - - $ref: >- - #/components/schemas/BranchAndFinancialInstitutionIdentification8 + - $ref: '#/components/schemas/IdentificationVerificationIndicator' - description: | - Debtor - Party that owes an amount of money to the (ultimate) creditor. - DbtrAcct: + Verification + Identifies whether the party and/or account information received is correct. Boolean value. + Rsn: allOf: - - $ref: "#/components/schemas/CashAccount40" + - $ref: '#/components/schemas/VerificationReason1Choice' - description: | - DebtorAccount - Account used to process a payment. - DbtrAgt: + Reason + Specifies the reason why the verified identification information is incorrect. + OrgnlPtyAndAcctId: allOf: - - $ref: >- - #/components/schemas/BranchAndFinancialInstitutionIdentification8 + - $ref: '#/components/schemas/IdentificationInformation4' - description: | - DebtorAgent - Financial institution servicing an account for the debtor. - CdtrAgt: + OriginalPartyAndAccountIdentification + Provides party and/or account identification information as given in the original message. + UpdtdPtyAndAcctId: allOf: - - $ref: >- - #/components/schemas/BranchAndFinancialInstitutionIdentification8 + - $ref: '#/components/schemas/IdentificationInformation4' - description: | - CreditorAgent - Financial institution servicing an account for the creditor. - Cdtr: + UpdatedPartyAndAccountIdentification + Provides party and/or account identification information. + required: + - OrgnlId + - Vrfctn + - Rsn + 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 + GetPartiesError_IdentificationVerificationReportV03: + title: GetPartiesError_IdentificationVerificationReportV03 + type: object + properties: + Assgnmt: allOf: - - $ref: >- - #/components/schemas/BranchAndFinancialInstitutionIdentification8 + - $ref: '#/components/schemas/IdentificationAssignment3' - description: | - Creditor - Party to which an amount of money is due. - CdtrAcct: + Assignment + Information related to the identification assignment. + Rpt: allOf: - - $ref: "#/components/schemas/CashAccount40" + - $ref: '#/components/schemas/VerificationReport4b' - description: | - CreditorAccount - Account to which a credit entry is made. - InstrForCdtrAgt: - allOf: - - $ref: "#/components/schemas/InstructionForCreditorAgent3" - - description: > - InstructionForCreditorAgent - - Set of elements used to provide information on the remittance - advice. - Purp: + Report + Information concerning the verification of the identification data for which verification was requested. + SplmtryData: allOf: - - $ref: "#/components/schemas/Purpose2Choice" + - $ref: '#/components/schemas/SupplementaryData1' - description: | - Purpose - Underlying reason for the payment transaction. - VrfctnOfTerms: - allOf: - - $ref: "#/components/schemas/CryptographicLockChoice" - - description: > - VerificationOfTerms - - Set of elements used to provide information on the underlying - terms of the transaction. + SupplementaryData + Additional information that cannot be captured in the structured elements and/or any other specific block. required: - - PmtId - - IntrBkSttlmAmt - - Dbtr - - Cdtr + - Assgnmt + - Rpt example: - PmtId: - InstrId: INSTRID - EndToEndId: ENDTOENDID + Assgnmt: + Id: 123 + CreDtTm: '2013-03-07T16:30:00' + Assgnr: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + Assgne: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + Rpt: + Id: 123 + CreDtTm: '2013-03-07T16:30:00' + RptgPty: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + RptdPty: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + RptdDoc: + Nb: 123 + RltdDt: '2013-03-07' + RltdDtTp: + Cd: 123 + Rsn: + Cd: 123 + Prtry: 123 + SplmtryData: + PlcAndNm: 123 + Envlp: 123 + RltdDt: '2013-03-07' + RltdDtTp: + Cd: 123 + Max15NumericText: + title: Max15NumericText + description: | + Specifies a numeric string with a maximum length of 15 digits. + type: string + pattern: ^[0-9]{1,15}$ + example: 123456789012345 + SettlementMethod1Code: + title: SettlementMethod1Code + description: | + Specifies the method used to settle the credit transfer instruction. + Only the CLRG: Clearing option is supported. + type: string + enum: + - CLRG + example: CLRG + SettlementInstruction15: + title: SettlementInstruction15 + description: | + Only the CLRG: Clearing option is supported. + Specifies the details on how the settlement of the original transaction(s) between the + instructing agent and the instructed agent was completed. + type: object + properties: + SttlmMtd: + $ref: '#/components/schemas/SettlementMethod1Code' + required: + - SttlmMtd + example: + SttlmMtd: CLRG PmtTpInf: + InstrPrty: NORM + SvcLvl: + Cd: SEPA LclInstrm: - Cd: CHQB - Prtry: PROPRIETARY - IntrBkSttlmAmt: - Amount: 123.45 - Ccy: EUR - Dbtr: - Nm: Debtor Name - DbtrAcct: - Id: - IBAN: IBAN - DbtrAgt: - FinInstnId: - BICFI: BICFI - CdtrAgt: - FinInstnId: - BICFI: BICFI - Cdtr: - Nm: Creditor Name - CdtrAcct: - Id: - IBAN: IBAN - InstrForCdtrAgt: - Cd: INSTRUCTION - Purp: - Cd: CHAR - VrfctnOfTerms: - Cntt: CONTENT - CnttTp: PROPRIETARY - CreditTransferTransaction68_FX_Quotes: - title: CreditTransferTransaction68_FX_Quotes - description: > - Provides further details specific to the individual transaction(s) - included in the message. + 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 + GroupHeader129: + title: GroupHeader129 + description: | + Group Header Set of characteristics shared by all individual transactions included in the message. type: object properties: - PmtId: - allOf: - - $ref: "#/components/schemas/PaymentIdentification13" - - description: | - PaymentIdentification - Set of elements used to reference a payment instruction. - PmtTpInf: + MsgId: allOf: - - $ref: "#/components/schemas/PaymentTypeInformation28" + - $ref: '#/components/schemas/Max35Text' - description: | - PaymentTypeInformation - Set of elements used to further specify the type of transaction. - UndrlygCstmrCdtTrf: + Message Identification + CreDtTm: allOf: - - $ref: "#/components/schemas/UnderlyingCustomerCreditTransfer" + - $ref: '#/components/schemas/ISODateTime' - description: | - Underlying Customer Credit Transfer - TBD - IntrBkSttlmAmt: - allOf: - - $ref: "#/components/schemas/ActiveCurrencyAndAmount" - - description: > - InterbankSettlementAmount - - Amount of money moved between the instructing agent and the - instructed agent. - Dbtr: + Creation Date and Time + PmtInstrXpryDtTm: allOf: - - $ref: >- - #/components/schemas/BranchAndFinancialInstitutionIdentification8 + - $ref: '#/components/schemas/ISODateTime' - description: | - Debtor - Party that owes an amount of money to the (ultimate) creditor. - DbtrAcct: + Payment Instruction Expiry Date and Time + NbOfTxs: allOf: - - $ref: "#/components/schemas/CashAccount40" + - $ref: '#/components/schemas/Max15NumericText' - description: | - DebtorAccount - Account used to process a payment. - DbtrAgt: + Number of Transactions + SttlmInf: allOf: - - $ref: >- - #/components/schemas/BranchAndFinancialInstitutionIdentification8 + - $ref: '#/components/schemas/SettlementInstruction15' - description: | - DebtorAgent - Financial institution servicing an account for the debtor. - CdtrAgt: + Settlement Information + required: + - MsgId + - CreDtTm + - NbOfTxs + - SttlmInf + example: + MsgId: 12345 + CreDtTm: '2020-01-01T00:00:00Z' + PmtInstrXpryDtTm: '2020-01-01T00:00:00Z' + NbOfTxs: 1 + SttlmInf: + SttlmMtd: CLRG + SttlmAcct: + Id: + IBAN: 123 + SttlmAcctOwnr: + Nm: John Doe + SttlmAcctSvcr: + BICFI: 123 + ULIDIdentifier: + title: ULIDIdentifier + type: string + pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ + example: 01AN4Z07BY79KA1307SR9X4MV3 + UUIDv4Identifier: + title: UUIDv4Identifier + type: string + example: 8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ + PaymentIdentification13: + title: PaymentIdentification13 + description: | + Provides further means of referencing a payment transaction. + type: object + properties: + InstrId: allOf: - - $ref: >- - #/components/schemas/BranchAndFinancialInstitutionIdentification8 + - $ref: '#/components/schemas/ULIDIdentifier' - description: | - CreditorAgent - Financial institution servicing an account for the creditor. - Cdtr: + InstructionIdentification (FSPIOP equivalent: transactionRequestId) + + Definition: Unique identification, as assigned by an instructing party for an instructed party, to + unambiguously identify the instruction. + + Usage: The instruction identification is a point to point reference that can be used between the + instructing party and the instructed party to refer to the individual instruction. It can be included in + several messages related to the instruction. + + This field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema. + EndToEndId: allOf: - - $ref: >- - #/components/schemas/BranchAndFinancialInstitutionIdentification8 + - $ref: '#/components/schemas/ULIDIdentifier' - description: | - Creditor - Party to which an amount of money is due. - CdtrAcct: + EndToEndIdentification (FSPIOP equivalent: transactionId) + + Definition: Unique identification, as assigned by the initiating party, to unambiguously identify the + transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. + + Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the + transaction. It can be included in several messages related to the transaction. + + Usage: In case there are technical limitations to pass on multiple references, the end-to-end + identification must be passed on throughout the entire end-to-end chain. + + This field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema. + TxId: allOf: - - $ref: "#/components/schemas/CashAccount40" + - $ref: '#/components/schemas/ULIDIdentifier' - description: | - CreditorAccount - Account to which a credit entry is made. - InstrForCdtrAgt: - allOf: - - $ref: "#/components/schemas/InstructionForCreditorAgent3_FX_Quotes" - - description: > - InstructionForCreditorAgent + TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request) - Set of elements used to provide information on the remittance - advice. - Purp: + 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. + + Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to + the transaction on the interbank level. + + Usage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period. + + This field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema. + UETR: allOf: - - $ref: "#/components/schemas/Purpose2Choice" + - $ref: '#/components/schemas/UUIDv4Identifier' - description: | - Purpose - Underlying reason for the payment transaction. - VrfctnOfTerms: + UETR + Universally unique identifier to provide an end-to-end reference of a payment transaction. + ClrSysRef: allOf: - - $ref: "#/components/schemas/CryptographicLockChoice" - - description: > - VerificationOfTerms - - Set of elements used to provide information on the underlying - terms of the transaction. + - $ref: '#/components/schemas/Max35Text' + - description: | + ClearingSystemReference + Unique reference, as assigned by a clearing system, to unambiguously identify the instruction. required: - - PmtId - - IntrBkSttlmAmt - - Dbtr - - Cdtr + - TxId 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 + InstrId: INSTRUCTIONID + EndToEndId: ENDTOENDID + TxId: TRANSACTIONID + UETR: 123e4567-e89b-12d3-a456-426614174000 + ClrSysRef: CLRSYSREF + Priority2Code: + title: Priority2Code description: | - Cryptographically signed terms + Indicator of the urgency or order of importance that the instructing party + would like the instructed party to apply to the processing of the instruction. + + HIGH: High priority + NORM: Normal priority + type: string + enum: + - HIGH + - NORM + example: HIGH + ClearingChannel2Code: + title: ClearingChannel2Code + description: | + Specifies the clearing channel for the routing of the transaction, as part of + the payment type identification. + + RTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system. + RTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system. + MPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system. + BOOK: BookTransfer Payment through internal book transfer. + type: string + enum: + - RTGS + - RTNS + - MPNS + - BOOK + example: RTGS + ExternalServiceLevel1Code: + title: ExternalServiceLevel1Code + description: Specifies the external service level code. + type: string + minLength: 1 + maxLength: 4 + example: 1234 + ServiceLevel8Choice: + title: ServiceLevel8Choice + description: | + Details about a service level. type: object anyOf: - properties: - IlpV4PrepPacket: + Cd: allOf: - - $ref: "#/components/schemas/hexBinary" - - description: > - Interledger Protocol packet (ILPv4) containing - Cryptographically signed terms + - $ref: '#/components/schemas/ExternalServiceLevel1Code' + - description: | + Code + Specifies a pre-agreed service or level of service between the parties, as published in an external service level code list. required: - - IlpV4PrepPacket + - Cd - properties: - Sh256Sgntr: + Prtry: allOf: - - $ref: "#/components/schemas/Exact32HexBinaryText" + - $ref: '#/components/schemas/Max35Text' - description: | - SHA-256 signature of the terms + Proprietary + Specifies a pre-agreed service or level of service between the parties, as a proprietary code. required: - - Sh256Sgntr + - Prtry example: - IlpV4PrepPacket: 1234567890ABCDEF - DateAndDateTime2Choice: - title: StatusReason6Choice + Cd: SEPA + ExternalLocalInstrument1Code: + title: ExternalLocalInstrument1Code + description: Specifies the external local instrument identification code. + type: string + minLength: 1 + maxLength: 35 + example: 12345 + LocalInstrument2Choice: + title: LocalInstrument2Choice + type: object description: | - Specifies the reason for the status. + Specifies the local instrument, as published in an external local instrument code list or as a proprietary code. + anyOf: + - properties: + Cd: + allOf: + - $ref: '#/components/schemas/ExternalLocalInstrument1Code' + - description: | + Code + Specifies the local instrument, as published in an external local instrument code list. + required: + - Cd + - properties: + Prtry: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Proprietary + Specifies the local instrument, as a proprietary code. + required: + - Prtry + example: + Cd: CH03 + ExternalCategoryPurpose1Code: + description: | + Specifies the category purpose, as published in an external category purpose code list. + External code sets can be downloaded from www.iso20022.org. + maxLength: 4 + minLength: 1 + type: string + example: 1234 + CategoryPurpose1Choice: + title: CategoryPurpose1Choice + description: | + Contains details about high level purpose of the mandate based on a set of pre-defined categories. type: object anyOf: - properties: - Dt: + Cd: allOf: - - $ref: "#/components/schemas/ISODate" + - $ref: '#/components/schemas/ExternalCategoryPurpose1Code' - description: | - Date - Specified date. + Code + Category purpose, as published in an external category purpose code list. required: - - Dt + - Cd - properties: - DtTm: + Prtry: allOf: - - $ref: "#/components/schemas/ISODateTime" + - $ref: '#/components/schemas/Max35Text' - description: | - DateTime - Specified date and time. + Proprietary + Category purpose, in a proprietary form. required: - - DtTm + - Prtry example: - DtTm: "2020-01-01T00:00:00Z" - DateAndPlaceOfBirth1: - title: DateAndPlaceOfBirth1 + Cd: CASH + PaymentTypeInformation28: + title: PaymentTypeInformation28 description: | - Details about date and place of birth of a person. + Provides further details of the type of payment. type: object properties: - BirthDt: - allOf: - - $ref: "#/components/schemas/ISODate" - - description: | - BirthDate - Date on which a person was born. - PrvcOfBirth: + InstrPrty: + $ref: '#/components/schemas/Priority2Code' + ClrChanl: + $ref: '#/components/schemas/ClearingChannel2Code' + SvcLvl: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/ServiceLevel8Choice' - description: | - ProvinceOfBirth - Province where a person was born. - CityOfBirth: + ServiceLevel + Agreement under which or rules under which the transaction should be processed. + LclInstrm: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/LocalInstrument2Choice' - description: | - CityOfBirth - City where a person was born. - CtryOfBirth: + LocalInstrument + Definition: User community specific instrument. + Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. + CtgyPurp: allOf: - - $ref: "#/components/schemas/CountryCode" + - $ref: '#/components/schemas/CategoryPurpose1Choice' - description: | - CountryOfBirth - Country where a person was born. - required: - - BirthDt - - CityOfBirth - - CtryOfBirth + CategoryPurpose + Specifies the high level purpose of the instruction based on a set of pre-defined categories. 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. + InstrPrty: NORM + ClrChanl: RTGS + SvcLvl: + Cd: SEPA + LclInstrm: + Cd: CORE + CtgyPurp: + Cd: CASH + ActiveOrHistoricCurrencyAndAmount_SimpleType: + title: ActiveOrHistoricCurrencyAndAmount_SimpleType + type: string + example: 123.45 + pattern: ^(?!0\d)(\d{1,18}|\d{1,17}.\d{1}|\d{1,16}.\d{1,2}|\d{1,15}.\d{1,3}|\d{1,14}.\d{1,4}|\d{1,13}.\d{1,5})$ + ActiveOrHistoricCurrencyAndAmount: + title: ActiveOrHistoricCurrencyAndAmount type: object + description: | + A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217. properties: - FrDt: + ActiveOrHistoricCurrencyAndAmount: allOf: - - $ref: "#/components/schemas/ISODate" + - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType' - description: | - FromDate - Start date of the range. - ToDt: + Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. + Ccy: allOf: - - $ref: "#/components/schemas/ISODate" + - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' - description: | - ToDate - End date of the range. + Currency + Identification of the currency in which the account is held. required: - - FrDt - - ToDt + - ActiveOrHistoricCurrencyAndAmount + - Ccy 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: - $ref: "#/components/schemas/ErrorCode" - errorDescription: - $ref: "#/components/schemas/ErrorDescription" - extensionList: - $ref: "#/components/schemas/ExtensionList" - required: - - errorCode - - errorDescription - ErrorInformationResponse: - title: ErrorInformationResponse + ActiveOrHistoricCurrencyAndAmount: 123.45 + Ccy: USD + PostalAddress27: + title: PostalAddress27 type: object - description: > - Data model for the complex type object that contains an optional element - ErrorInformation used along with 4xx and 5xx responses. - properties: - errorInformation: - $ref: "#/components/schemas/ErrorInformation" - Exact32HexBinaryText: - title: Exact32HexBinaryText description: | - Specifies a hexadecimal string. - - NOTE: This pattern is not the original ISO20022 specification. - type: string - pattern: ^[A-Za-z0-9-_]{43}$ - maxLength: 48 - Exact4AlphaNumericText: - title: Exact4AlphaNumericText + Information that locates and identifies a specific address, as defined by postal services. + properties: + AdrTp: + allOf: + - $ref: '#/components/schemas/AddressType3Choice' + - description: Type of address, as defined by the postal services. + CareOf: + allOf: + - $ref: '#/components/schemas/Max140Text' + - description: Name of the person or entity the mail is directed to, if different from the recipient. + Dept: + allOf: + - $ref: '#/components/schemas/Max70Text' + - description: Name of a department within an organization. + SubDept: + allOf: + - $ref: '#/components/schemas/Max70Text' + - description: Name of a sub-department within a department. + StrtNm: + allOf: + - $ref: '#/components/schemas/Max140Text' + - description: Name of the street or thoroughfare. + BldgNb: + allOf: + - $ref: '#/components/schemas/Max16Text' + - description: Number that identifies a building on the street. + BldgNm: + allOf: + - $ref: '#/components/schemas/Max140Text' + - description: Name of the building, if applicable. + Flr: + allOf: + - $ref: '#/components/schemas/Max70Text' + - description: Floor number or identifier within a building. + UnitNb: + allOf: + - $ref: '#/components/schemas/Max16Text' + - description: Unit or apartment number within a building. + PstBx: + allOf: + - $ref: '#/components/schemas/Max16Text' + - description: Post office box number. + Room: + allOf: + - $ref: '#/components/schemas/Max70Text' + - description: Room number or identifier within a building. + PstCd: + allOf: + - $ref: '#/components/schemas/Max16Text' + - description: Postal code or ZIP code. + TwnNm: + allOf: + - $ref: '#/components/schemas/Max140Text' + - description: Name of the town or city. + TwnLctnNm: + allOf: + - $ref: '#/components/schemas/Max140Text' + - description: Name of the location within a town or city. + DstrctNm: + allOf: + - $ref: '#/components/schemas/Max140Text' + - description: Name of the district or region. + CtrySubDvsn: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: Name of the country subdivision, such as a state or province. + Ctry: + allOf: + - $ref: '#/components/schemas/CountryCode' + - description: Country code, as defined by ISO 3166-1 alpha-2. + AdrLine: + allOf: + - $ref: '#/components/schemas/Max70Text' + - description: Free-form text line for the address. + example: + AdrTp: ADDR + CareOf: CareOf + Dept: Dept + SubDept: SubDept + StrtNm: StrtNm + BldgNb: BldgNb + BldgNm: BldgNm + Flr: Flr + UnitNb: UnitNb + PstBx: PstBx + Room: Room + PstCd: PstCd + TwnNm: TwnNm + TwnLctnNm: TwnLctnNm + DstrctNm: DstrctNm + CtrySubDvsn: CtrySubDvsn + Ctry: Ctry + AdrLine: AdrLine + Max256Text: + title: Max256Text description: | - Specifies an alphanumeric string with a length of 4 characters. + Specifies a character string with a maximum length of 256 characters. type: string - pattern: ^[a-zA-Z0-9]{4}$ - example: 1234 - Execute_FIToFICustomerCreditTransferV13: - title: Execute_FIToFICustomerCreditTransferV13 + minLength: 1 + maxLength: 256 + example: 256 + GenericOrganisationIdentification3: + title: GenericOrganisationIdentification3 type: object + description: | + Information related to an identification of an organisation. properties: - GrpHdr: + Id: allOf: - - $ref: "#/components/schemas/GroupHeader129" - - description: > - Group Header - - Set of characteristics shared by all individual transactions - included in the message. - CdtTrfTxInf: + - $ref: '#/components/schemas/Max256Text' + - description: | + Identification + Identification assigned by an institution. + SchmeNm: allOf: - - $ref: "#/components/schemas/CreditTransferTransaction67" - - description: > - Credit Transfer Transaction Information - - Set of elements providing information specific to the individual - credit transfer(s). + - $ref: '#/components/schemas/OrganisationIdentificationSchemeName1Choice' + - description: | + SchemeName + Name of the identification scheme. + Issr: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Issuer + Entity that assigns the identification. required: - - GrpHdr - - CdtTrfTxInf + - Id example: - GrpHdr: - MsgId: 12345 - CreDtTm: "2020-01-01T00:00:00Z" - PmtInstrXpryDtTm: "2020-01-01T00:00:00Z" - NbOfTxs: 1 - SttlmInf: - SttlmMtd: INDA - SttlmAcct: - Id: - IBAN: 123 - SttlmAcctOwnr: - Nm: John Doe - SttlmAcctSvcr: - BICFI: 123 - CdtTrfTxInf: - PmtId: - InstrId: 123 - EndToEndId: 123 - PmtTpInf: - InstrPrty: NORM - InstdAmt: - Amt: 123 - Ccy: EUR - ChrgBr: SHAR - CdtrAgt: - FinInstnId: - BICFI: 123 - Cdtr: - Nm: John Doe - CdtrAcct: - Id: - IBAN: 123 - RmtInf: - Ustrd: Test - Extension: - title: Extension + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC + OrganisationIdentification39: + title: OrganisationIdentification39 + description: | + Unique and unambiguous way to identify an organisation. + type: object + properties: + AnyBIC: + allOf: + - $ref: '#/components/schemas/AnyBICDec2014Identifier' + - description: | + AnyBIC + Business identification code of the organisation. + LEI: + allOf: + - $ref: '#/components/schemas/LEIIdentifier' + - description: | + LEI + Legal entity identification as an alternate identification for a party. + Othr: + allOf: + - $ref: '#/components/schemas/GenericOrganisationIdentification3' + - description: | + Other + Unique identification of an organisation, as assigned by an institution, using an identification scheme. + example: + AnyBIC: BICFI + LEI: 529900T8BM49AURSDO55 + Othr: + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC + GenericPersonIdentification2: + title: GenericPersonIdentification2 type: object - description: Data model for the complex type Extension. + description: Identification of a person. properties: - key: - $ref: "#/components/schemas/ExtensionKey" - value: - $ref: "#/components/schemas/ExtensionValue" + Id: + allOf: + - $ref: '#/components/schemas/Max256Text' + - description: | + Identification + Unique and unambiguous identification of a person. + SchmeNm: + allOf: + - $ref: '#/components/schemas/PersonIdentificationSchemeName1Choice' + - description: | + SchemeName + Name of the identification scheme. + Issr: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Issuer + Entity that assigns the identification. required: - - key - - value - ExtensionKey: - title: ExtensionKey - type: string - minLength: 1 - maxLength: 32 - description: Extension key. - ExtensionList: - title: ExtensionList + - Id + example: + Id: 123 + SchmeNm: + Cd: DRLC + Issr: BIC + PersonIdentification18: + title: PersonIdentification18 + description: | + Unique and unambiguous way to identify a person. type: object - description: > - Data model for the complex type ExtensionList. An optional list of - extensions, specific to deployment. properties: - extension: - type: array - items: - $ref: "#/components/schemas/Extension" - 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. - 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. - type: string - minLength: 1 - maxLength: 4 - example: 1234 - ExternalCategoryPurpose1Code: - description: > - Specifies the category purpose, as published in an external category - purpose code list. - - External code sets can be downloaded from www.iso20022.org. - maxLength: 4 - minLength: 1 - type: string - example: 1234 - ExternalChargeType1Code: - title: ExternalChargeType1Code - description: | - Specifies the type of charge applied to the transaction. - type: string - minLength: 1 - maxLength: 4 - example: 1234 - ExternalClearingSystemIdentification1Code: - title: ExternalClearingSystemIdentification1Code + DtAndPlcOfBirth: + allOf: + - $ref: '#/components/schemas/DateAndPlaceOfBirth1' + - description: | + DateAndPlaceOfBirth + Date and place of birth of a person. + Othr: + allOf: + - $ref: '#/components/schemas/GenericPersonIdentification2' + - description: | + Other + Unique identification of a person, as assigned by an institution, using an identification scheme. + example: + DtAndPlcOfBirth: + Dt: '2018-01-01' + CityOfBirth: City + Othr: + Id: 123 + SchmeNm: + Cd: CUST + Prtry: 1 + Party52Choice: + title: Party52Choice description: | - Specifies the external clearing system identification code. - 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. - - - For FSPIOP transfer state enumeration mappings: - - { - "COMM": "COMMITED", - "RESV": "RESERVED", - "RECV": "RECEIVED", - "ABOR": "ABORTED" - } - - - NOTE: enum enforcement is not apart of the ISO20022 specification, but - is added here for FSPIOP mappings. - type: string - minLength: 1 - maxLength: 4 - example: COMM - enum: - - COMM - - RESV - - RECV - - ABOR - ExternalPersonIdentification1Code: - title: ExternalPersonIdentification1Code - description: Specifies the external person identification code. - type: string - minLength: 1 - maxLength: 4 - example: 1234 - ExternalProxyAccountType1Code: - title: ExternalProxyAccountType1Code - description: Specifies the external proxy account type code. - type: string - minLength: 1 - maxLength: 4 - example: 1234 - ExternalPurpose1Code: - title: ExternalPurpose1Code - description: Specifies the external purpose code. - type: string - minLength: 1 - maxLength: 4 - example: 1234 - ExternalServiceLevel1Code: - title: ExternalServiceLevel1Code - description: Specifies the external service level code. - type: string - minLength: 1 - maxLength: 4 - example: 1234 - ExternalStatusReason1Code: - title: ExternalStatusReason1Code - description: Specifies the external status reason code. - type: string - minLength: 1 - maxLength: 4 - example: 1234 - ExternalVerificationReason1Code: - title: ExternalVerificationReason1Code - description: Specifies the external verification reason code. - type: string - minLength: 1 - maxLength: 4 - example: 1234 - FinancialIdentificationSchemeName1Choice: - title: FinancialIdentificationSchemeName1Choice + NOTE: Unsure on the description. type: object - description: | - Specifies the name of the identification scheme. anyOf: - properties: - Cd: + OrgId: allOf: - - $ref: >- - #/components/schemas/ExternalFinancialInstitutionIdentification1Code - - description: > - Code - - Name of the identification scheme, in a coded form as - published in an external list. + - $ref: '#/components/schemas/OrganisationIdentification39' + - description: | + Organisation + Unique and unambiguous way to identify an organisation. required: - - Cd + - OrgId - properties: - Prtry: + PrvtId: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/PersonIdentification18' - description: | - Proprietary - Name of the identification scheme, in a free text form. + Person + Unique and unambiguous identification of a person, for example a passport. required: - - Prtry + - PrvtId example: - Cd: BIC - FinancialInstitutionIdentification18: - title: FinancialInstitutionIdentification18 - type: object + OrgId: + AnyBIC: BIC + PrvtId: + DtAndPlcOfBirth: + Dt: '2018-01-01' + CityOfBirth: City + PreferredContactMethod2Code: + title: PreferredContactMethod2Code + description: | + Preferred method used to reach the individual contact within an organisation. + LETT: Letter + MAIL: Email + PHON: Phone + FAXX: Fax + CELL: Mobile phone + type: string + enum: + - LETT + - MAIL + - PHON + - FAXX + - CELL + example: MAIL + Contact13: + title: Contact13 description: | - Information used to identify a financial institution. + Specifies the details of the contact person. + type: object properties: - BICFI: + NmPrfx: allOf: - - $ref: "#/components/schemas/BICFIDec2014Identifier" - - description: > - BICFI - - Code allocated to a financial institution by the ISO 9362 - Registration Authority as described in ISO 9362 "Banking - - Banking telecommunication messages - Business identifier code - (BIC)" - ClrSysMmbId: + - $ref: '#/components/schemas/NamePrefix2Code' + - description: | + NamePrefix + Specifies the terms used to formally address a person. + Nm: allOf: - - $ref: "#/components/schemas/ClearingSystemMemberIdentification2" + - $ref: '#/components/schemas/Max140Text' - description: | - ClearingSystemMemberIdentification - Information used to identify a member within a clearing system - LEI: + Name + Name by which a party is known and which is usually used to identify that party. + PhneNb: allOf: - - $ref: "#/components/schemas/LEIIdentifier" + - $ref: '#/components/schemas/PhoneNumber' - description: | - LEI - Legal entity identifier of the financial institution. - Nm: + PhoneNumber + Collection of information that identifies a phone number, as defined by telecom services. + MobNb: allOf: - - $ref: "#/components/schemas/Max140Text" - - description: > - Name - - Name by which an agent is known and which is usually used to - identify that agent - PstlAdr: + - $ref: '#/components/schemas/PhoneNumber' + - description: | + MobilePhoneNumber + Collection of information that identifies a mobile phone number, as defined by telecom services. + FaxNb: allOf: - - $ref: "#/components/schemas/PostalAddress24" - - description: > - PostalAddress - - Information that locates and identifies a specific address, as - defined by postal services. - Othr: + - $ref: '#/components/schemas/PhoneNumber' + - description: | + FaxNumber + Collection of information that identifies a fax number, as defined by telecom services. + URLAdr: allOf: - - $ref: "#/components/schemas/GenericFinancialIdentification1" - - description: > - Other - - Unique identification of an agent, as assigned by an - institution, using an identification scheme. - 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. - properties: - BICFI: + - $ref: '#/components/schemas/Max2048Text' + - description: | + URLAddress + Address for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service. + EmailAdr: allOf: - - $ref: "#/components/schemas/BICFIDec2014Identifier" - - description: > - BICFI - - Code allocated to a financial institution by the ISO 9362 - Registration Authority as described in ISO 9362 "Banking - - Banking telecommunication messages - Business identifier code - (BIC)" - ClrSysMmbId: + - $ref: '#/components/schemas/Max256Text' + - description: | + EmailAddress + Address for electronic mail (e-mail). + EmailPurp: allOf: - - $ref: "#/components/schemas/ClearingSystemMemberIdentification2" + - $ref: '#/components/schemas/Max35Text' - description: | - ClearingSystemMemberIdentification - Information used to identify a member within a clearing system - LEI: + EmailPurpose + Purpose for which an email address may be used. + JobTitl: allOf: - - $ref: "#/components/schemas/LEIIdentifier" + - $ref: '#/components/schemas/Max35Text' - description: | - LEI - Legal entity identifier of the financial institution. - Nm: + JobTitle + Title of the function. + Rspnsblty: allOf: - - $ref: "#/components/schemas/Max140Text" - - description: > - Name - - Name by which an agent is known and which is usually used to - identify that agent - PstlAdr: + - $ref: '#/components/schemas/Max35Text' + - description: | + Responsibility + Role of a person in an organisation. + Dept: allOf: - - $ref: "#/components/schemas/PostalAddress24" - - description: > - PostalAddress - - Information that locates and identifies a specific address, as - defined by postal services. + - $ref: '#/components/schemas/Max70Text' + - description: | + Department + Identification of a division of a large organisation or building. Othr: allOf: - - $ref: "#/components/schemas/GenericFinancialIdentification1" - - description: > - Other - - Unique identification of an agent, as assigned by an - institution, using an identification scheme. - required: [] + - $ref: '#/components/schemas/OtherContact1' + - description: | + OtherContact + Contact details in another form. + PrefrdMtd: + allOf: + - $ref: '#/components/schemas/PreferredContactMethod2Code' + - description: | + PreferredContactMethod + Preferred method used to reach the contact. 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 + 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 + PartyIdentification272: + title: PartyIdentification272 + description: | + Specifies the identification of a person or an organisation. type: object - description: > - FxRequest_FICreditTransferProposal - - A group of elements providing information specific to the individual - credit transfer(s) included in the message. properties: - GrpHdr: + Nm: allOf: - - $ref: "#/components/schemas/GroupHeader113" - - description: > - GroupHeader - - Set of characteristics shared by all individual transactions - included in the message. - CdtTrfTxInf: + - $ref: '#/components/schemas/Max140Text' + - description: | + Name + Name by which a party is known and which is usually used to identify that party. + PstlAdr: allOf: - - $ref: "#/components/schemas/CreditTransferTransaction68_FX_Quotes" + - $ref: '#/components/schemas/PostalAddress27' - description: | - Credit Transfer Transaction Information - 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 - - The FxResponse_FICreditTransferConfirmation message is sent by the FSP - to the Payer FSP to confirm the successful processing of the credit - transfer. - properties: - GrpHdr: + Postal Address + Information that locates and identifies a specific address, as defined by postal services. + Id: + allOf: + - $ref: '#/components/schemas/Party52Choice' + - description: | + Identification + Unique and unambiguous identification of a party. + CtryOfRes: allOf: - - $ref: "#/components/schemas/GroupHeader113" - - description: > - GroupHeader - - Set of characteristics shared by all individual transactions - included in the message. - CdtTrfTxInf: + - $ref: '#/components/schemas/CountryCode' + - description: | + Country of Residence + Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed. + CtctDtls: allOf: - - $ref: "#/components/schemas/CreditTransferTransaction68_FX_Quotes" - - description: > - CreditTransferTransaction68_FX_Quotes - - Set of elements providing information specific to the individual - credit transfer(s). + - $ref: '#/components/schemas/Contact13' + - description: | + Contact Details + Set of elements used to indicate how to contact the party. required: - - GrpHdr - - CdtTrfTxInf + - Id example: - GrpHdr: - MsgId: 20191122-123456 - CreDtTm: "2019-11-22T12:34:56" - NbOfTxs: 1 - CtrlSum: 100 - InitgPty: - Nm: Initiating Party Name - MsgRcpt: - Nm: Message Recipient Name - CdtTrfTxInf: - PmtId: - InstrId: 20191122-123456 - EndToEndId: 20191122-123456 - PmtTpInf: - InstrPrty: NORM - CtgyPurp: SUPP - IntrBkSttlmAmt: - Amt: 100 - Ccy: EUR - ChrgBr: SHAR - Cdtr: - Nm: Creditor Name - CdtrAcct: - Id: - IBAN: BE71096123456769 - Tp: - Cd: CACC - Ccy: EUR - Nm: My account - CdtrAgt: - FinInstnId: - BICFI: BNBABEBB - CdtrAgtAcct: - Id: - IBAN: BE71096123456769 - Tp: - Cd: CACC - Ccy: EUR - Nm: My account - Dbtr: - Nm: Debtor Name - DbtrAcct: - Id: - IBAN: BE71096123456769 - Tp: - Cd: CACC - Ccy: EUR - Nm: My account - DbtrAgt: - FinInstnId: - BICFI: BNBABEBB - DbtrAgtAcct: - Id: - IBAN: BE71096123456769 - Tp: - Cd: CACC - Ccy: EUR - Nm: My account - RmtInf: - Ustrd: Remittance Information - RgltryRptg: - Dbtr: - Nm: Debtor Name - DbtrAcct: - Id: - IBAN: BE71096123456769 - Tp: - Cd: CACC - Ccy: EUR - Nm: My account - Fxecute_FinancialInstitutionCreditTransferV12: - title: Fxecute_FinancialInstitutionCreditTransferV12 + 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 + FinancialInstitutionIdentification23: + title: FinancialInstitutionIdentification23 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. + description: | + Information used to identify a financial institution. properties: - GrpHdr: + BICFI: allOf: - - $ref: "#/components/schemas/GroupHeader129" - - description: > - GroupHeader. - - Set of characteristics shared by all individual transactions - included in the message. - CdtTrfTxInf: + - $ref: '#/components/schemas/BICFIDec2014Identifier' + - description: | + BICFI + Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)" + ClrSysMmbId: allOf: - - $ref: "#/components/schemas/CreditTransferTransaction68" - - description: > - CreditTransferTransactionInformation. - - Set of elements providing information specific to the individual - credit transfer(s). + - $ref: '#/components/schemas/ClearingSystemMemberIdentification2' + - description: | + ClearingSystemMemberIdentification + Information used to identify a member within a clearing system + LEI: + allOf: + - $ref: '#/components/schemas/LEIIdentifier' + - description: | + LEI + Legal entity identifier of the financial institution. + Nm: + allOf: + - $ref: '#/components/schemas/Max140Text' + - description: | + Name + Name by which an agent is known and which is usually used to identify that agent + PstlAdr: + allOf: + - $ref: '#/components/schemas/PostalAddress24' + - description: | + PostalAddress + Information that locates and identifies a specific address, as defined by postal services. + Othr: + allOf: + - $ref: '#/components/schemas/GenericFinancialIdentification1' + - description: | + Other + Unique identification of an agent, as assigned by an institution, using an identification scheme. required: - - GrpHdr - - CdtTrfTxInf + - Othr example: - GrpHdr: - MsgId: 20191113001 - CreDtTm: "2019-11-13T10:00:00" - NbOfTxs: 1 - CtrlSum: 1000 - InitgPty: - Nm: Initiating Party Name - Id: - OrgId: - Othr: - Id: 123456789 - SchmeNm: - Cd: BBA - FwdgAgt: - FinInstnId: - BICFI: BBBBBBBB - DbtrAgt: - FinInstnId: - BICFI: AAAAAAAA - CdtrAgt: - FinInstnId: - BICFI: CCCCCCCC - CdtTrfTxInf: - PmtId: - InstrId: 20191113001 - EndToEndId: 20191113001 - PmtTpInf: - InstrPrty: NORM - CtgyPurp: - Cd: SUPP - InstrForCdtrAgt: - Cd: /ACC/123456789 - IntrBkSttlmAmt: - Amt: 1000 - Ccy: EUR - ChrgBr: SHAR - CdtrAgt: - FinInstnId: - BICFI: CCCCCCCC - Cdtr: - Nm: Creditor Name - CdtrAcct: - Id: - IBAN: BE71096123456769 - RmtInf: - Ustrd: Payment for invoice 12345 - GenericAccountIdentification1: - title: GenericAccountIdentification1 + 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 + BranchData5: + title: BranchData5 + description: | + Information that locates and identifies a specific branch of a financial institution. type: object - description: > - GenericAccountIdentification - - Unique and unambiguous identification of an account, as assigned by the - account servicer. properties: Id: allOf: - - $ref: "#/components/schemas/Max34Text" + - $ref: '#/components/schemas/Max35Text' - description: | Identification - Identification assigned by an institution. - SchmeNm: + Unique and unambiguous identification of a branch of a financial institution. + LEI: allOf: - - $ref: "#/components/schemas/AccountSchemeName1Choice" + - $ref: '#/components/schemas/LEIIdentifier' - description: | - SchemeName - Name of the identification scheme. - Issr: + LEI + Legal entity identification for the branch of the financial institution. + Nm: + allOf: + - $ref: '#/components/schemas/Max140Text' + - description: | + Name + Name by which an agent is known and which is usually used to identify that agent. + PstlAdr: + allOf: + - $ref: '#/components/schemas/PostalAddress27' + - description: | + PostalAddress + Information that locates and identifies a specific address, as defined by postal services. + example: + Id: 123 + LEI: 123 + Nm: Name + PstlAdr: + AdrTp: ADDR + Dept: Department + SubDept: Sub department + StrtNm: Street name + BldgNb: Building number + BranchAndFinancialInstitutionIdentification8: + title: BranchAndFinancialInstitutionIdentification8 + type: object + description: | + Unique and unambiguous identification of a financial institution or a branch of a financial institution. + properties: + FinInstnId: + allOf: + - $ref: '#/components/schemas/FinancialInstitutionIdentification23' + - description: | + FinancialInstitutionIdentification + Unique and unambiguous identification of a financial institution or a branch of a financial institution. + BrnchId: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/BranchData5' - description: | - Issuer - Entity that assigns the identification. + BranchIdentification + Identifies a specific branch of a financial institution. required: - - Id + - FinInstnId example: - Id: 123 - SchmeNm: - Cd: IBAN - Issr: BIC - GenericFinancialIdentification1: - title: GenericFinancialIdentification1 + 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 + UnderlyingCustomerCreditTransfer: + title: UnderlyingCustomerCreditTransfer type: object - description: > - GenericFinancialIdentification - - Unique and unambiguous identification of a person, which is used to - refer to a person in a financial context. properties: - Id: + InstdAmt: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' - description: | - Identification - Unique and unambiguous identification of a person. - SchmeNm: + 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. + Dbtr: allOf: - - $ref: "#/components/schemas/FinancialIdentificationSchemeName1Choice" + - $ref: '#/components/schemas/PartyIdentification272' - description: | - SchemeName - Name of the identification scheme. - Issr: + Party that owes an amount of money to the (ultimate) creditor. + Cdtr: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/PartyIdentification272' - description: | - Issuer - Entity that assigns the identification. - required: - - Id - example: - Id: 123 - SchmeNm: - Cd: IBAN - Issr: BIC - GenericIdentification3: - title: GenericIdentification3 - type: object - description: | - Generic scheme identification for a party. - properties: - Id: + Party to which an amount of money is due. + DbtrAgt: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - Identification - - Name or number assigned by an entity to enable recognition of - that entity, for example, account identifier. - Issr: + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' + - description: | + Financial institution servicing an account for the debtor. + CdtrAgt: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' - description: | - Issuer - Entity that assigns the identification. + Financial institution servicing an account for the creditor. required: - - Id - example: - Id: 123 - Issr: BIC - GenericIdentification30: - title: GenericIdentification30 + - Dbtr + - Cdtr + - DbtrAgt + - CdtrAgt + - InstdAmt + ActiveCurrencyAndAmount_SimpleType: + title: ActiveCurrencyAndAmount_SimpleType + type: string + pattern: ^(?!0\d)(\d{1,18}|\d{1,17}.\d{1}|\d{1,16}.\d{1,2}|\d{1,15}.\d{1,3}|\d{1,14}.\d{1,4}|\d{1,13}.\d{1,5})$ + example: 123.45 + ActiveCurrencyCode: + title: ActiveCurrencyCode + type: string + description: |- + A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". + NOTE: This has been modified away from the original ISO20022 pattern to enums. + example: USD + minLength: 3 + maxLength: 3 + enum: + - AED + - AFN + - ALL + - AMD + - ANG + - AOA + - ARS + - AUD + - AWG + - AZN + - BAM + - BBD + - BDT + - BGN + - BHD + - BIF + - BMD + - BND + - BOB + - BRL + - BSD + - BTN + - BWP + - BYN + - BZD + - CAD + - CDF + - CHF + - CLP + - CNY + - COP + - CRC + - CUC + - CUP + - CVE + - CZK + - DJF + - DKK + - DOP + - DZD + - EGP + - ERN + - ETB + - EUR + - FJD + - FKP + - GBP + - GEL + - GGP + - GHS + - GIP + - GMD + - GNF + - GTQ + - GYD + - HKD + - HNL + - HRK + - HTG + - HUF + - IDR + - ILS + - IMP + - INR + - IQD + - IRR + - ISK + - JEP + - JMD + - JOD + - JPY + - KES + - KGS + - KHR + - KMF + - KPW + - KRW + - KWD + - KYD + - KZT + - LAK + - LBP + - LKR + - LRD + - LSL + - LYD + - MAD + - MDL + - MGA + - MKD + - MMK + - MNT + - MOP + - MRO + - MUR + - MVR + - MWK + - MXN + - MYR + - MZN + - NAD + - NGN + - NIO + - NOK + - NPR + - NZD + - OMR + - PAB + - PEN + - PGK + - PHP + - PKR + - PLN + - PYG + - QAR + - RON + - RSD + - RUB + - RWF + - SAR + - SBD + - SCR + - SDG + - SEK + - SGD + - SHP + - SLL + - SOS + - SPL + - SRD + - STD + - SVC + - SYP + - SZL + - THB + - TJS + - TMT + - TND + - TOP + - TRY + - TTD + - TVD + - TWD + - TZS + - UAH + - UGX + - USD + - UYU + - UZS + - VEF + - VND + - VUV + - WST + - XAF + - XCD + - XDR + - XOF + - XPF + - XTS + - XXX + - YER + - ZAR + - ZMW + - ZWD + ActiveCurrencyAndAmount: + title: ActiveCurrencyAndAmount type: object description: | - Generic scheme identification for a party. + A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. properties: - Id: - allOf: - - $ref: "#/components/schemas/Exact4AlphaNumericText" - - description: > - Identification - - Proprietary information, often a code, issued by the data source - scheme issuer. - Issr: + ActiveCurrencyAndAmount: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: | - Issuer - Entity that assigns the identification. - SchmeNm: + - $ref: '#/components/schemas/ActiveCurrencyAndAmount_SimpleType' + Ccy: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/ActiveCurrencyCode' - description: | - SchemeName - Short textual description of the scheme. + Currency + Identification of the currency in which the account is held. required: - - Id - - Issr + - ActiveCurrencyAndAmount + - Ccy example: - Id: 1234 - Issr: BIC - SchmeNm: BICFI - GenericOrganisationIdentification1: - title: GenericOrganisationIdentification1 - type: object + ActiveCurrencyAndAmount: 123.45 + Ccy: USD + BaseOneRate: + title: BaseOneRate + type: string description: | - Information that locates and identifies an organisation. - properties: - Id: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - Identification for an organisation. FSPIOP equivalent to Party - Identifier for an organisation in ISO 20022. Identification - assigned by an institution. - SchmeNm: - allOf: - - $ref: "#/components/schemas/OrganisationIdentificationSchemeName1Choice" - - description: | - SchemeName - Name of the identification scheme. - Issr: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: | - Issuer - Entity that assigns the identification. - required: - - Id - example: - Id: 123 - SchmeNm: - Cd: BIC - Issr: BIC - GenericOrganisationIdentification3: - title: GenericOrganisationIdentification3 + Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%. + 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})$ + ChargeBearerType1Code: + title: ChargeBearerType1Code + description: | + Specifies which party(ies) will pay charges due for processing of the + instruction. + + DEBT: BorneByDebtor All transaction charges are to be borne by the debtor. + CRED: BorneByCreditor All transaction charges are to be borne by the creditor. + SHAR: This charge code is not supported, however it is used in testing when the charge bearer is unknown. + type: string + enum: + - DEBT + - CRED + - SHAR + example: DEBT + ExternalChargeType1Code: + title: ExternalChargeType1Code + description: | + Specifies the type of charge applied to the transaction. + type: string + minLength: 1 + maxLength: 4 + example: 1234 + GenericIdentification3: + title: GenericIdentification3 type: object description: | - Information related to an identification of an organisation. + Generic scheme identification for a party. properties: Id: allOf: - - $ref: "#/components/schemas/Max256Text" + - $ref: '#/components/schemas/Max35Text' - description: | Identification - Identification assigned by an institution. - SchmeNm: - allOf: - - $ref: "#/components/schemas/OrganisationIdentificationSchemeName1Choice" - - description: | - SchemeName - Name of the identification scheme. + Name or number assigned by an entity to enable recognition of that entity, for example, account identifier. Issr: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/Max35Text' - description: | Issuer Entity that assigns the identification. @@ -4156,2181 +4502,1745 @@ components: - Id example: Id: 123 - SchmeNm: - Cd: BIC Issr: BIC - GenericPersonIdentification1: - title: GenericPersonIdentification1 - type: object + ChargeType3Choice: + title: ChargeType3Choice description: | - GenericPersonIdentification1 - Information that locates and identifies a specific person. - properties: - Id: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: | - Identification - Unique and unambiguous identification of a person. - SchmeNm: - allOf: - - $ref: "#/components/schemas/PersonIdentificationSchemeName1Choice" - - description: | - SchemeName - Name of the identification scheme. - Issr: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: | - Issuer - Entity that assigns the identification. - required: - - Id + ChargeType3Choice + Specifies the type of charge. + type: object + anyOf: + - properties: + Cd: + allOf: + - $ref: '#/components/schemas/ExternalChargeType1Code' + - description: | + Code + Charge type, in a coded form. + required: + - Cd + - properties: + Prtry: + allOf: + - $ref: '#/components/schemas/GenericIdentification3' + - description: | + Proprietary + Type of charge in a proprietary form, as defined by the issuer. + required: + - Prtry example: - Id: 123 - SchmeNm: - Cd: DRLC - Issr: BIC - GenericPersonIdentification2: - title: GenericPersonIdentification2 + Cd: CASH + Charges16: + title: Charges16 + description: | + NOTE: Unsure on description. + + Seemingly a generic schema for charges, with an amount, agent, and type. type: object - description: Identification of a person. properties: - Id: + Amt: allOf: - - $ref: "#/components/schemas/Max256Text" + - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' - description: | - Identification - Unique and unambiguous identification of a person. - SchmeNm: + Amount + Transaction charges to be paid by the charge bearer. + Agt: allOf: - - $ref: "#/components/schemas/PersonIdentificationSchemeName1Choice" + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' - description: | - SchemeName - Name of the identification scheme. - Issr: + Agent + Agent that takes the transaction charges or to which the transaction charges are due. + Tp: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/ChargeType3Choice' - description: | - Issuer - Entity that assigns the identification. + Type + Defines the type of charges. required: - - Id + - Amt + - Agt example: - Id: 123 - SchmeNm: - Cd: DRLC - Issr: BIC - GetPartiesError_IdentificationVerificationReportV03: - title: GetPartiesError_IdentificationVerificationReportV03 + Amt: + ActiveOrHistoricCurrencyAndAmount: 123.45 + Ccy: USD + Agt: + BrnchId: + Id: BRANCHID + FinInstnId: + BICFI: BICFI + Tp: + Cd: SHAR + ExternalCreditorAgentInstruction1Code: + title: ExternalCreditorAgentInstruction1Code + description: Specifies the instruction given by the creditor to the creditor agent. + type: string + minLength: 1 + maxLength: 4 + example: 1234 + 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. type: object properties: - Assgnmt: + Cd: allOf: - - $ref: "#/components/schemas/IdentificationAssignment3" + - $ref: '#/components/schemas/ExternalCreditorAgentInstruction1Code' - description: | - Assignment - Information related to the identification assignment. - Rpt: - allOf: - - $ref: "#/components/schemas/VerificationReport4" - - description: > - Report - - Information concerning the verification of the identification - data for which verification was requested. - SplmtryData: + Code + Coded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent. + InstrInf: allOf: - - $ref: "#/components/schemas/SupplementaryData1" - - description: > - SupplementaryData - - Additional information that cannot be captured in the structured - elements and/or any other specific block. - required: - - Assgnmt - - Rpt + - $ref: '#/components/schemas/Max140Text' + - description: | + InstructionInformation + Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community. example: - Assgnmt: - Id: 123 - CreDtTm: "2013-03-07T16:30:00" - Assgnr: - Id: - Id: 123 - SchmeNm: - Cd: IBAN - Issr: BIC - Assgne: - Id: - Id: 123 - SchmeNm: - Cd: IBAN - Issr: BIC - Rpt: - Id: 123 - CreDtTm: "2013-03-07T16:30:00" - RptgPty: - Id: - Id: 123 - SchmeNm: - Cd: IBAN - Issr: BIC - RptdPty: - Id: - Id: 123 - SchmeNm: - Cd: IBAN - Issr: BIC - RptdDoc: - Nb: 123 - RltdDt: "2013-03-07" - RltdDtTp: - Cd: 123 - Rsn: - Cd: 123 - Prtry: 123 - SplmtryData: - PlcAndNm: 123 - Envlp: 123 - RltdDt: "2013-03-07" - RltdDtTp: - Cd: 123 - GetParties_IdentificationVerificationReportV03: - title: GetParties_IdentificationVerificationReportV03 + Cd: PHOA + InstrInf: Please advise/contact next agent by phone. + Instruction4Code: + title: Instruction4Code + description: | + Specifies further instructions concerning the processing of a payment + instruction, provided by the sending clearing agent to the next agent(s). + + PHOA: PhoneNextAgent Please advise/contact next agent by phone. + TELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication. + type: string + enum: + - PHOA + - TELA + example: PHOA + 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. type: object properties: - Assgnmt: + Cd: allOf: - - $ref: "#/components/schemas/IdentificationAssignment3" + - $ref: '#/components/schemas/Instruction4Code' - description: | - Assignment - Identifies the identification assignment. - Rpt: + Code + Coded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain. + InstrInf: allOf: - - $ref: "#/components/schemas/VerificationReport4" - - description: > - Report + - $ref: '#/components/schemas/Max140Text' + - description: | + InstructionInformation + Further information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community. + example: + Cd: PHOA + InstrInf: Please advise/contact next agent by phone. + ExternalPurpose1Code: + title: ExternalPurpose1Code + description: Specifies the external purpose code. + type: string + minLength: 1 + maxLength: 4 + example: 1234 + Purpose2Choice: + title: Purpose2Choice + description: | + Specifies the underlying reason for the payment transaction. - Information concerning the verification of the identification - data for which verification was requested. - SplmtryData: - allOf: - - $ref: "#/components/schemas/SupplementaryData1" - - description: > - SupplementaryData + Usage: Purpose is used by the end-customers, that is initiating party, + (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose + is a content element, which is not used for processing by any of the agents involved in the payment + chain. + type: object + anyOf: + - properties: + Cd: + allOf: + - $ref: '#/components/schemas/ExternalPurpose1Code' + - description: | + Code - Additional information that cannot be captured in the structured - elements and/or any other specific block. - required: - - Assgnmt - - Rpt + Underlying reason for the payment transaction, as published in an external purpose code list. + required: + - Cd + - properties: + Prtry: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Proprietary + + Purpose, in a proprietary form. + required: + - Prtry 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. + Cd: CH03 + RegulatoryReportingType1Code: + title: RegulatoryReportingType1Code + description: | + Identifies whether the regulatory reporting information applies to the debit + side, to the credit side or to both debit and credit sides of the transaction. + + CRED: Regulatory reporting applies to the credit side of the transaction. + DEBT: Regulatory reporting applies to the debit side of the transaction. + BOTH: Regulatory reporting applies to both debit and credit sides of the transaction. + type: string + enum: + - CRED + - DEBT + - BOTH + example: BOTH + RegulatoryAuthority2: + title: RegulatoryAuthority2 + description: | + Information about an entity requiring the regulatory reporting information. type: object properties: - MsgId: + Nm: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/Max140Text' - description: | - Message Identification - CreDtTm: + Name + + Name of the entity requiring the regulatory reporting information. + Ctry: allOf: - - $ref: "#/components/schemas/ISODateTime" + - $ref: '#/components/schemas/CountryCode' - description: | - Creation Date and Time - NbOfTxs: + Country + + Country of the entity that requires the regulatory reporting information. + example: + Nm: Swiss National Bank + Ctry: CH + Max10Text: + title: Max10Text + description: | + Specifies a character string with a maximum length of 10 characters. + type: string + minLength: 1 + maxLength: 10 + example: 1234567890 + StructuredRegulatoryReporting3: + title: StructuredRegulatoryReporting3 + description: | + StructuredRegulatoryReporting3 + + Information needed due to regulatory and statutory requirements. + type: object + properties: + Tp: allOf: - - $ref: "#/components/schemas/Max15NumericText" + - $ref: '#/components/schemas/Max35Text' - description: | - Number of Transactions - TtlIntrBkSttlmAmt: + Type + + Specifies the type of the information supplied in the regulatory reporting details. + Dt: allOf: - - $ref: "#/components/schemas/ActiveCurrencyAndAmount" + - $ref: '#/components/schemas/ISODate' - description: | - Total Interbank Settlement Amount - SttlmInf: + Date + + Date related to the specified type of regulatory reporting details. + Ctry: allOf: - - $ref: "#/components/schemas/SettlementInstruction15" + - $ref: '#/components/schemas/CountryCode' - description: | - Settlement Information - PmtTpInf: + Country + + Country related to the specified type of regulatory reporting details. + Cd: allOf: - - $ref: "#/components/schemas/PaymentTypeInformation28" + - $ref: '#/components/schemas/Max10Text' - description: | - Payment Type Information - required: - - MsgId - - CreDtTm - - NbOfTxs - - SttlmInf + Code + Specifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form. + Amt: + allOf: + - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' + - description: | + Amount + + Amount of money to be reported for regulatory and statutory requirements. + Inf: + description: | + Information + + Additional details that cater for specific domestic regulatory requirements. + anyOf: + - $ref: '#/components/schemas/Max35Text' + - items: + $ref: '#/components/schemas/Max35Text' + type: array 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. + Tp: T1 + Dt: '2018-01-01' + Ctry: CH + Cd: CHF + Amt: + Ccy: CHF + Amt: 1000 + Inf: 12345 + RegulatoryReporting3: + title: RegulatoryReporting3 + description: | + Information needed due to regulatory and/or statutory requirements. type: object properties: - MsgId: + DbtCdtRptgInd: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - MessageIdentification - - Definition: Point to point reference, as assigned by the - instructing party, and sent to the next party in the chain to - unambiguously identify the message. - - Usage: The instructing party has to make sure that - MessageIdentification is unique per instructed party for a - pre-agreed period. - CreDtTm: + - $ref: '#/components/schemas/RegulatoryReportingType1Code' + - description: | + DebitCreditReportingIndicator + Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. + Authrty: allOf: - - $ref: "#/components/schemas/ISODateTime" + - $ref: '#/components/schemas/RegulatoryAuthority2' - description: | - CreationDateTime - Date and time at which the message was created. - required: - - MsgId - - CreDtTm + Authority + + Entity requiring the regulatory reporting information. + Dtls: + description: | + Details + Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. + anyOf: + - $ref: '#/components/schemas/StructuredRegulatoryReporting3' + - items: + $ref: '#/components/schemas/StructuredRegulatoryReporting3' + type: array 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. + DbtCdtRptgInd: CRED + Authrty: + Nm: Swiss National Bank + Ctry: CH + Dtls: + Cd: A1 + Inf: Mandatory regulatory information + TaxParty1: + title: TaxParty1 + description: | + Details about the entity involved in the tax paid or to be paid. type: object properties: - MsgId: + TaxId: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/Max35Text' - description: | - Message Identification - CreDtTm: + TaxIdentification + + Tax identification number of the creditor. + RegnId: allOf: - - $ref: "#/components/schemas/ISODateTime" + - $ref: '#/components/schemas/Max35Text' - description: | - Creation Date and Time - PmtInstrXpryDtTm: + RegistrationIdentification + + Unique identification, as assigned by an organisation, to unambiguously identify a party. + TaxTp: allOf: - - $ref: "#/components/schemas/ISODateTime" + - $ref: '#/components/schemas/Max35Text' - description: | - Payment Instruction Expiry Date and Time - NbOfTxs: + TaxType + + Type of tax payer. + example: + TaxId: 123456789 + RegnId: 123456789 + TaxTp: VAT + TaxAuthorisation1: + title: TaxAuthorisation1 + description: | + Details of an authorised tax paying party. + type: object + properties: + Titl: allOf: - - $ref: "#/components/schemas/Max15NumericText" + - $ref: '#/components/schemas/Max35Text' - description: | - Number of Transactions - SttlmInf: + Title + + Title or position of debtor or the debtor's authorised representative. + Nm: allOf: - - $ref: "#/components/schemas/SettlementInstruction15" + - $ref: '#/components/schemas/Max140Text' - description: | - Settlement Information - 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 - - - International Bank Account Number (IBAN)" and replaced by the more - recent edition of the standard. - 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. - type: string - format: date - example: "2013-03-07" - ISODateTime: - title: ISODateTime - 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 - - (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format - - (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in - - "XML Schema Part 2: Datatypes Second Edition - - - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. - - - Note on the time format: - - 1) beginning / end of calendar day - - 00:00:00 = the beginning of a calendar day - - 24:00:00 = the end of a calendar day - - - 2) fractions of second in time format - - Decimal fractions of seconds may be included. In this case, the + Name - involved parties shall agree on the maximum number of digits that are - allowed. - 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 + Name of the debtor or the debtor's authorised representative. + example: + Titl: Mr + Nm: John Doe + TaxParty2: + title: TaxParty2 description: | - Year represented by YYYY (ISO 8601). - type: string - pattern: ^\d{4}(Z|([+-]\d{2}:\d{2})){0,1}$ - example: 2019 - IdentificationAssignment3: - title: IdentificationAssignment3 + Details about the entity involved in the tax paid or to be paid. type: object - description: > - IdentificationAssignment - - Information that unambiguously identifies a message, as assigned by the - assignor to the assignee. properties: - MsgId: + TaxId: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - MessageIdentification + - $ref: '#/components/schemas/Max35Text' + - description: | + TaxIdentification - Unique identification, as assigned by the assigner, to - unambiguously identify the message. - CreDtTm: + Tax identification number of the debtor. + RegnId: allOf: - - $ref: "#/components/schemas/ISODateTime" - - description: > - CreationDateTime + - $ref: '#/components/schemas/Max35Text' + - description: | + RegistrationIdentification - Date and time at which the identification assignment was - created. - Assgnr: + Unique identification, as assigned by an organisation, to unambiguously identify a party. + TaxTp: allOf: - - $ref: "#/components/schemas/Party40Choice" - - description: > - Assignor + - $ref: '#/components/schemas/Max35Text' + - description: | + TaxType - Party that assigns the identification assignment to another - party. This is also the sender of the message. - Assgne: + Type of tax payer. + Authstn: allOf: - - $ref: "#/components/schemas/Party40Choice" - - description: > - Assignee + - $ref: '#/components/schemas/TaxAuthorisation1' + - description: | + Authorisation - Party that the identification assignment is assigned to. This is - also the receiver of the message. - required: - - MsgId - - CreDtTm - - Assgnr - - Assgne + Details of the authorised tax paying party. 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 + TaxId: 123456789 + RegnId: 123456789 + TaxTp: VAT + Authstn: + Titl: Mr + Nm: John Doe + Number: + title: Number + type: string + example: 256 + pattern: ^(?!0\d)\d{1,18}$ + DatePeriod2: + title: DatePeriod2 description: | - Information that locates and identifies a specific party or account. + Range of time defined by a start date and an end date. + type: object properties: - Pty: - allOf: - - $ref: "#/components/schemas/PartyIdentification135" - - description: > - Party - - Account owner that owes an amount of money or to whom an amount - of money is due. - Acct: + FrDt: allOf: - - $ref: "#/components/schemas/CashAccount40" + - $ref: '#/components/schemas/ISODate' - description: | - Account - Unambiguous identification of the account of a party. - Agt: + FromDate + Start date of the range. + ToDt: allOf: - - $ref: >- - #/components/schemas/BranchAndFinancialInstitutionIdentification6 + - $ref: '#/components/schemas/ISODate' - description: | - Agent - Financial institution servicing an account for a party. + ToDate + End date of the range. required: - - Pty + - FrDt + - ToDt 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. - - - • Meaning When True: Indicates that the identification information - received is correct. - - • Meaning When False: Indicates that the identification information - received is incorrect - Instruction4Code: - title: Instruction4Code - description: > - Specifies further instructions concerning the processing of a payment - - instruction, provided by the sending clearing agent to the next - agent(s). - - - PHOA: PhoneNextAgent Please advise/contact next agent by phone. + FrDt: '2022-01-01' + ToDt: '2022-12-31' + TaxRecordPeriod1Code: + title: TaxRecordPeriod1Code + description: | + Specifies the period related to the tax payment - TELA: TelecomNextAgent Please advise/contact next agent by the most - efficient means of telecommunication. + MM01 FirstMonth Tax is related to the second month of the period. + MM02 SecondMonth Tax is related to the first month of the period. + MM03 ThirdMonth Tax is related to the third month of the period. + MM04 FourthMonth Tax is related to the fourth month of the period. + MM05 FifthMonth Tax is related to the fifth month of the period. + MM06 SixthMonth Tax is related to the sixth month of the period. + MM07 SeventhMonth Tax is related to the seventh month of the period. + MM08 EighthMonth Tax is related to the eighth month of the period. + MM09 NinthMonth Tax is related to the ninth month of the period. + MM10 TenthMonth Tax is related to the tenth month of the period. + MM11 EleventhMonth Tax is related to the eleventh month of the period. + MM12 TwelfthMonth Tax is related to the twelfth month of the period. + QTR1 FirstQuarter Tax is related to the first quarter of the period. + QTR2 SecondQuarter Tax is related to the second quarter of the period. + QTR3 ThirdQuarter Tax is related to the third quarter of the period. + QTR4 FourthQuarter Tax is related to the forth quarter of the period. + HLF1 FirstHalf Tax is related to the first half of the period. + HLF2 SecondHalf Tax is related to the second half of the period. + type: string + enum: + - MM01 + - MM02 + - MM03 + - MM04 + - MM05 + - MM06 + - MM07 + - MM08 + - MM09 + - MM10 + - MM11 + - MM12 + - QTR1 + - QTR2 + - QTR3 + - QTR4 + - HLF1 + - HLF2 + example: HLF1 + ISOYear: + title: ISOYear + description: | + Year represented by YYYY (ISO 8601). 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. + pattern: ^\d{4}(Z|([+-]\d{2}:\d{2})){0,1}$ + example: 2019 + TaxPeriod3: + title: TaxPeriod3 + description: | + Period of time details related to the tax payment. type: object properties: - Cd: + FrToDt: allOf: - - $ref: "#/components/schemas/ExternalCreditorAgentInstruction1Code" - - description: > - Code + - $ref: '#/components/schemas/DatePeriod2' + - description: | + FromToDate - Coded information related to the processing of the payment - instruction, provided by the initiating party, and intended for - the creditor's agent. - InstrInf: + Range of time between a start date and an end date for which the tax report is provided. + Tp: allOf: - - $ref: "#/components/schemas/Max140Text" - - description: > - InstructionInformation + - $ref: '#/components/schemas/TaxRecordPeriod1Code' + - description: | + Type + + Identification of the period related to the tax payment. + Yr: + allOf: + - $ref: '#/components/schemas/ISOYear' + - description: | + Year - Further information complementing the coded instruction or - instruction to the creditor's agent that is bilaterally agreed - or specific to a user community. + Year related to the tax payment. example: - Cd: PHOA - InstrInf: Please advise/contact next agent by phone. - InstructionForCreditorAgent3_FX_Quotes: - title: InstructionForCreditorAgent3_Put_FX_Quotes_ID - description: > - Further information related to the processing of the payment - instruction, provided by the initiating party, and intended for the - creditor agent. + Yr: 2020 + Tp: MM01 + FrToDt: + FrDt: '2020-01-01' + ToDt: '2020-01-31' + 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})$ + TaxRecordDetails3: + title: TaxRecordDetails3 + description: | + Details on the tax period and amount. type: object properties: - Cd: + Prd: allOf: - - $ref: "#/components/schemas/ExternalCreditorAgentInstruction1Code" - - description: > - Code + - $ref: '#/components/schemas/TaxPeriod3' + - description: | + Period - Coded information related to the processing of the payment - instruction, provided by the initiating party, and intended for - the creditor's agent. - InstrInf: + Set of elements used to provide details on the period of time related to the tax payment. + Amt: allOf: - - $ref: "#/components/schemas/AmountTypeEnum" - - description: > - InstructionInformation + - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' + - description: | + Amount - Further information complementing the coded instruction or - instruction to the creditor's agent that is bilaterally agreed - or specific to a user community. + Underlying tax amount related to the specified period. + required: + - Amt 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. + Prd: + Yr: 2020 + Tp: MM01 + FrToDt: + FrDt: '2020-01-01' + ToDt: '2020-01-31' + Amt: + Amt: 100 + Ccy: EUR + TaxAmount3: + title: TaxAmount3 + description: | + Information on the amount of the tax record. type: object properties: - Cd: + Rate: allOf: - - $ref: "#/components/schemas/Instruction4Code" - - description: > - Code + - $ref: '#/components/schemas/PercentageRate' + - description: | + Rate - Coded information related to the processing of the payment - instruction, provided by the initiating party, and intended for - the next agent in the payment chain. - InstrInf: + Rate used to calculate the tax. + TaxblBaseAmt: allOf: - - $ref: "#/components/schemas/Max140Text" - - description: > - InstructionInformation + - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' + - description: | + TaxableBaseAmount - Further information complementing the coded instruction or - instruction to the next agent that is bilaterally agreed or - specific to a user community. - 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})$ - 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. - anyOf: - - properties: - Cd: - allOf: - - $ref: "#/components/schemas/ExternalLocalInstrument1Code" - - description: > - Code + Amount of money on which the tax is based. + TtlAmt: + allOf: + - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' + - description: | + TotalAmount - Specifies the local instrument, as published in an external - local instrument code list. - required: - - Cd - - properties: - Prtry: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: | - Proprietary - Specifies the local instrument, as a proprietary code. - required: - - Prtry - example: - Cd: CH03 - Max105Text: - title: Max105Text - description: | - Specifies a character string with a maximum length of 105 characters. - type: string - minLength: 1 - maxLength: 105 - example: 12345 - Max10Text: - title: Max10Text - description: | - Specifies a character string with a maximum length of 10 characters. - type: string - minLength: 1 - maxLength: 10 - example: 1234567890 - Max128Text: - title: Max128Text - description: | - Specifies a character string with a maximum length of 128 characters. - type: string - minLength: 1 - maxLength: 128 - example: 12345 - Max140Text: - title: Max140Text - description: | - Specifies a character string with a maximum length of 140 characters. - type: string - minLength: 1 - maxLength: 140 - example: 12345 - Max15NumericText: - title: Max15NumericText - description: | - Specifies a numeric string with a maximum length of 15 digits. - type: string - pattern: ^[0-9]{1,15}$ - example: 123456789012345 - Max16Text: - title: Max16Text - description: | - Specifies a character string with a maximum length of 16 characters. - type: string - minLength: 1 - maxLength: 16 - example: 1234567890123456 - Max2048Text: - title: Max2048Text - description: | - Specifies a character string with a maximum length of 2048 characters. - type: string - minLength: 1 - maxLength: 2048 - example: 2048 - Max256Text: - title: Max256Text - description: | - Specifies a character string with a maximum length of 256 characters. - type: string - minLength: 1 - maxLength: 256 - example: 256 - Max34Text: - title: Max34Text - description: | - Specifies a character string with a maximum length of 34 characters. - 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. - type: string - minLength: 1 - maxLength: 350 - example: 350 - Max35Text: - title: Max35Text - description: | - Specifies a character string with a maximum length of 35 characters. - 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. - type: string - minLength: 1 - maxLength: 4 - example: 1234 - Max70Text: - title: Max70Text - description: | - Specifies a character string with a maximum length of 70 characters. - type: string - minLength: 1 - maxLength: 70 - example: 1.2345678901234567e+99 - NamePrefix2Code: - description: | - Specifies the terms used to formally address a person. + Total amount that is the result of the calculation of the tax for the record. + Dtls: + description: | + Details - DOCT: Doctor or Dr - MADM: Madam - MISS: Miss - MIST: Mistress - MIKS: Mx - 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 + Set of elements used to provide details on the tax period and amount. + anyOf: + - $ref: '#/components/schemas/TaxRecordDetails3' + - items: + $ref: '#/components/schemas/TaxRecordDetails3' + 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 + TaxRecord3: + title: TaxRecord3 description: | - Unique and unambiguous way to identify an organisation. + Set of elements used to define the tax record. type: object properties: - AnyBIC: + AddtlInf: allOf: - - $ref: "#/components/schemas/AnyBICDec2014Identifier" + - $ref: '#/components/schemas/Max140Text' - description: | - AnyBIC - Business identification code of the organisation. - LEI: + AdditionalInformation + + Further details of the tax record. + CertId: allOf: - - $ref: "#/components/schemas/LEIIdentifier" - - description: > - LEI + - $ref: '#/components/schemas/Max35Text' + - description: | + CertificateIdentification - Legal entity identification as an alternate identification for a - party. - Othr: + Identification number of the tax report as assigned by the taxing authority. + Ctgy: allOf: - - $ref: "#/components/schemas/GenericOrganisationIdentification1" - - description: > - Other + - $ref: '#/components/schemas/Max35Text' + - description: | + Category - Unique identification of an organisation, as assigned by an - institution, using an identification scheme. - 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. - type: object - properties: - AnyBIC: + Specifies the tax code as published by the tax authority. + CtgyDtls: allOf: - - $ref: "#/components/schemas/AnyBICDec2014Identifier" + - $ref: '#/components/schemas/Max35Text' - description: | - AnyBIC - Business identification code of the organisation. - LEI: + CategoryDetails + + Provides further details of the category tax code. + DbtrSts: allOf: - - $ref: "#/components/schemas/LEIIdentifier" - - description: > - LEI + - $ref: '#/components/schemas/Max35Text' + - description: | + DebtorStatus - Legal entity identification as an alternate identification for a - party. - Othr: + Code provided by local authority to identify the status of the party that has drawn up the settlement document. + FrmsCd: allOf: - - $ref: "#/components/schemas/GenericOrganisationIdentification3" - - description: > - Other + - $ref: '#/components/schemas/Max35Text' + - description: | + FormsCode + + Identifies, in a coded form, on which template the tax report is to be provided. + Prd: + allOf: + - $ref: '#/components/schemas/TaxPeriod3' + - description: | + Period + + Set of elements used to provide details on the period of time related to the tax payment. + TaxAmt: + allOf: + - $ref: '#/components/schemas/TaxAmount3' + - description: | + TaxAmount + + Set of elements used to provide information on the amount of the tax record. + Tp: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Type - Unique identification of an organisation, as assigned by an - institution, using an identification scheme. + High level code to identify the type of tax details. example: - AnyBIC: BICFI - LEI: 529900T8BM49AURSDO55 - Othr: - Id: 123 - SchmeNm: - Cd: BIC - Issr: BIC - OrganisationIdentificationSchemeName1Choice: - title: OrganisationIdentificationSchemeName1Choice + 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 + TaxData1: + title: TaxData1 description: | - Choice of format for the organisation identification. + 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. type: object properties: - Cd: + Cdtr: allOf: - - $ref: "#/components/schemas/ExternalOrganisationIdentification1Code" - - description: > - Code + - $ref: '#/components/schemas/TaxParty1' + - description: | + Creditor - Name of the identification scheme, in a coded form as published - in an external list. - Prtry: + Party on the credit side of the transaction to which the tax applies. + Dbtr: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/TaxParty2' - description: | - Proprietary - Name of the identification scheme, in a free text form. - anyOf: - - properties: - Cd: {} - - properties: - Prtry: {} - example: - Cd: BIC - OtherContact1: - title: OtherContact1 - description: > - Communication device number or electronic address used for - communication. - type: object - properties: - ChanlTp: + Debtor + + Party on the debit side of the transaction to which the tax applies. + UltmtDbtr: allOf: - - $ref: "#/components/schemas/Max4Text" - - description: > - ChannelType + - $ref: '#/components/schemas/TaxParty2' + - description: | + UltimateDebtor - Method used to contact the financial institution's contact for - the specific tax region. - Id: + Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority. + AdmstnZone: allOf: - - $ref: "#/components/schemas/Max128Text" + - $ref: '#/components/schemas/Max35Text' - description: | - Identifier - Communication value such as phone number or email address. - 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. - properties: - GrpHdr: + AdministrationZone + + Territorial part of a country to which the tax payment is related. + RefNb: allOf: - - $ref: "#/components/schemas/GroupHeader120" - - description: > - Set of characteristics shared by all individual transactions - included in the message. - TxInfAndSts: + - $ref: '#/components/schemas/Max140Text' + - description: | + ReferenceNumber + + Tax reference information that is specific to a taxing agency. + Mtd: allOf: - - $ref: "#/components/schemas/PaymentTransaction163" - - description: > - Information concerning the original transactions, to which the - status report message refers. - SplmtryData: + - $ref: '#/components/schemas/Max35Text' + - description: | + Method + + Method used to indicate the underlying business or how the tax is paid. + TtlTaxblBaseAmt: 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: - 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: + - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' + - description: | + TotalTaxableBaseAmount + + Total amount of money on which the tax is based. + TtlTaxAmt: allOf: - - $ref: "#/components/schemas/GroupHeader120" - - description: > - Set of characteristics shared by all individual transactions - included in the message. - TxInfAndSts: + - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' + - description: | + TotalTaxAmount + + Total amount of money as result of the calculation of the tax. + Dt: allOf: - - $ref: "#/components/schemas/PaymentTransaction163" - - description: > - Information concerning the original transactions, to which the - status report message refers. - SplmtryData: + - $ref: '#/components/schemas/ISODate' + - description: | + Date + + Date by which tax is due. + SeqNb: 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: - 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. - type: object - anyOf: - - properties: - OrgId: - allOf: - - $ref: "#/components/schemas/OrganisationIdentification29" - - description: | - Organisation - Unique and unambiguous way to identify an organisation. - required: - - OrgId - - properties: - PrvtId: - allOf: - - $ref: "#/components/schemas/PersonIdentification13" - - description: > - PrivateIdentification + - $ref: '#/components/schemas/Number' + - description: | + SequenceNumber - Unique and unambiguous identification of a person, for - example a passport. - required: - - PrvtId + Sequential number of the tax report. + Rcrd: + description: | + Record + + Details of the tax record. + anyOf: + - $ref: '#/components/schemas/TaxRecord3' + - items: + $ref: '#/components/schemas/TaxRecord3' + type: array example: - OrgId: - AnyBIC: BIC - PrvtId: - DtAndPlcOfBirth: - Dt: "2018-01-01" - CityOfBirth: City - Party40Choice: - title: Party40Choice + 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 + hexBinary: + title: hexBinary + type: string + example: 4660 + pattern: ^[A-Za-z0-9-_]+[=]{0,2}$ + Exact32HexBinaryText: + title: Exact32HexBinaryText description: | - Identification of a person, an organisation or a financial institution. + Specifies a hexadecimal string. + + NOTE: This pattern is not the original ISO20022 specification. + type: string + pattern: ^[A-Za-z0-9-_]{43}$ + maxLength: 48 + CryptographicLockChoice: + title: CryptographicLockChoice + description: | + Cryptographically signed terms type: object anyOf: - properties: - Pty: + IlpV4PrepPacket: allOf: - - $ref: "#/components/schemas/PartyIdentification135" + - $ref: '#/components/schemas/hexBinary' - description: | - Party - Identification of a person or an organisation. + Interledger Protocol packet (ILPv4) containing Cryptographically signed terms required: - - Pty + - IlpV4PrepPacket - properties: - Agt: + Sh256Sgntr: allOf: - - $ref: >- - #/components/schemas/BranchAndFinancialInstitutionIdentification6 + - $ref: '#/components/schemas/Exact32HexBinaryText' - description: | - Agent - Identification of a financial institution. + SHA-256 signature of the terms required: - - Agt + - Sh256Sgntr example: - Pty: - Nm: Name + IlpV4PrepPacket: 1234567890ABCDEF + CreditTransferTransaction67: + title: CreditTransferTransaction67 + description: | + Provides further details specific to the individual transaction(s) included in the message. + type: object + properties: + PmtId: + allOf: + - $ref: '#/components/schemas/PaymentIdentification13' + - description: | + PaymentIdentification + Set of elements used to reference a payment instruction. + PmtTpInf: + allOf: + - $ref: '#/components/schemas/PaymentTypeInformation28' + - 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' + - description: | + InterbankSettlementAmount + Amount of money moved between the instructing agent and the instructed agent. + 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. + XchgRate: + allOf: + - $ref: '#/components/schemas/BaseOneRate' + - description: | + ExchangeRate + Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. + ChrgBr: + $ref: '#/components/schemas/ChargeBearerType1Code' + ChrgsInf: + allOf: + - $ref: '#/components/schemas/Charges16' + - description: | + ChargesInformation + Provides information on the charges to be paid by the charge bearer(s) related to the payment transaction. + Dbtr: + allOf: + - $ref: '#/components/schemas/PartyIdentification272' + - description: | + Debtor + Party that owes an amount of money to the (ultimate) creditor. + DbtrAcct: + allOf: + - $ref: '#/components/schemas/CashAccount40' + - description: | + DebtorAccount + Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. + DbtrAgt: + allOf: + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' + - description: | + DebtorAgent + Financial institution servicing an account for the debtor. + CdtrAgt: + allOf: + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' + - description: | + CreditorAgent + Financial institution servicing an account for the creditor. + Cdtr: + allOf: + - $ref: '#/components/schemas/PartyIdentification272' + - description: | + Creditor + Party to which an amount of money is due. + CdtrAcct: + allOf: + - $ref: '#/components/schemas/CashAccount40' + - description: | + CreditorAccount + Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. + InstrForCdtrAgt: + allOf: + - $ref: '#/components/schemas/InstructionForCreditorAgent3' + - description: | + InstructionForCreditorAgent + Set of elements used to provide information on the remittance advice. + InstrForNxtAgt: + allOf: + - $ref: '#/components/schemas/InstructionForNextAgent1' + - description: | + InstructionForNextAgent + Set of elements used to provide information on the remittance advice. + Purp: + allOf: + - $ref: '#/components/schemas/Purpose2Choice' + - description: | + Purpose + Underlying reason for the payment transaction. + RgltryRptg: + allOf: + - $ref: '#/components/schemas/RegulatoryReporting3' + - description: | + RegulatoryReporting + Information needed due to regulatory and statutory requirements. + Tax: + allOf: + - $ref: '#/components/schemas/TaxData1' + - description: | + Tax + Provides details on the tax. + VrfctnOfTerms: + $ref: '#/components/schemas/CryptographicLockChoice' + required: + - PmtId + - IntrBkSttlmAmt + - ChrgBr + - Dbtr + - DbtrAgt + - CdtrAgt + - Cdtr + - Purp + 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: - Ctry: US - AdrLine: - - Line1 - - Line2 + AdrTp: ADDR + BldgNb: BLDGNB + Ctry: CTRY + TwnNm: TWNNM + PstCd: PSTCD + StrtNm: STRTNM + DbtrAcct: Id: - OrgId: - AnyBIC: BIC - Agt: + IBAN: IBAN + DbtrAgt: + BrnchId: + Id: BRANCHID FinInstnId: - BICFI: BUKBGB22 + BICFI: BICFI + CdtrAgt: 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. + 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 + TermsRequest_FIToFICustomerCreditProposal: + title: TermsRequest_FIToFICustomerCreditProposal type: object - anyOf: - - properties: - OrgId: - allOf: - - $ref: "#/components/schemas/OrganisationIdentification39" - - description: | - Organisation - Unique and unambiguous way to identify an organisation. - required: - - OrgId - - properties: - PrvtId: - allOf: - - $ref: "#/components/schemas/PersonIdentification18" - - description: > - Person - - Unique and unambiguous identification of a person, for - example a passport. - 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. - type: object + This message is sent by a financial institution to a financial institution to propose the terms of a credit to a customer. properties: - Nm: - allOf: - - $ref: "#/components/schemas/Max140Text" - - description: > - Name - - Name by which a party is known and which is usually used to - identify that party. - PstlAdr: - allOf: - - $ref: "#/components/schemas/PostalAddress24" - - description: > - PostalAddress - - Information that locates and identifies a specific address, as - defined by postal services. - Id: + GrpHdr: allOf: - - $ref: "#/components/schemas/Party38Choice" + - $ref: '#/components/schemas/GroupHeader129' - description: | - Identification - Unique and unambiguous way to identify an organisation. - CtryOfRes: - allOf: - - $ref: "#/components/schemas/CountryCode" - - description: > - CountryOfResidence - - Country in which a person resides (the place of a person's - home). In the case of a company, it is the country from which - the affairs of that company are directed. - CtctDtls: + Group Header + Set of characteristics shared by all individual transactions included in the message. + CdtTrfTxInf: allOf: - - $ref: "#/components/schemas/Contact4" + - $ref: '#/components/schemas/CreditTransferTransaction67' - description: | - ContactDetails - Set of elements used to indicate how to contact the party. + Credit Transfer Transaction Information required: - - Id + - GrpHdr + - CdtTrfTxInf 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 + 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 + GroupHeader129b: + title: GroupHeader129 description: | - Specifies the identification of a person or an organisation. + Group Header Set of characteristics shared by all individual transactions included in the message. type: object properties: - Nm: + MsgId: allOf: - - $ref: "#/components/schemas/Max140Text" - - description: > - Name - - Name by which a party is known and which is usually used to - identify that party. - PstlAdr: + - $ref: '#/components/schemas/Max35Text' + - description: | + Message Identification + CreDtTm: allOf: - - $ref: "#/components/schemas/PostalAddress27" - - description: > - Postal Address - - Information that locates and identifies a specific address, as - defined by postal services. - Id: + - $ref: '#/components/schemas/ISODateTime' + - description: | + Creation Date and Time + PmtInstrXpryDtTm: allOf: - - $ref: "#/components/schemas/Party52Choice" + - $ref: '#/components/schemas/ISODateTime' - description: | - Identification - Unique and unambiguous identification of a party. - CtryOfRes: + Payment Instruction Expiry Date and Time + NbOfTxs: allOf: - - $ref: "#/components/schemas/CountryCode" - - description: > - Country of Residence - - Country in which a person resides (the place of a person's - home). In the case of a company, it is the country from which - the affairs of that company are directed. - CtctDtls: + - $ref: '#/components/schemas/Max15NumericText' + - description: | + Number of Transactions + SttlmInf: allOf: - - $ref: "#/components/schemas/Contact13" + - $ref: '#/components/schemas/SettlementInstruction15' - description: | - Contact Details - Set of elements used to indicate how to contact the party. + Settlement Information required: - - Id + - MsgId + - CreDtTm + - NbOfTxs + - SttlmInf + - PmtInstrXpryDtTm 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 + MsgId: 12345 + CreDtTm: '2020-01-01T00:00:00Z' + PmtInstrXpryDtTm: '2020-01-01T00:00:00Z' + NbOfTxs: 1 + SttlmInf: + SttlmMtd: CLRG + SttlmAcct: + Id: + IBAN: 123 + SttlmAcctOwnr: + Nm: John Doe + SttlmAcctSvcr: + BICFI: 123 + CreditTransferTransaction67b: + title: CreditTransferTransaction67 description: | - Provides further means of referencing a payment transaction. - type: object - properties: - InstrId: - allOf: - - $ref: "#/components/schemas/ULIDIdentifier" - - description: > - InstructionIdentification (FSPIOP equivalent: - transactionRequestId) - - - Definition: Unique identification, as assigned by an instructing - party for an instructed party, to - - unambiguously identify the instruction. - - - Usage: The instruction identification is a point to point - reference that can be used between the - - instructing party and the instructed party to refer to the - individual instruction. It can be included in - - several messages related to the instruction. - - - This field has been changed from the original ISO20022 - `Max35Text`` schema to a ULIDIdentifier schema. - EndToEndId: - allOf: - - $ref: "#/components/schemas/ULIDIdentifier" - - description: > - EndToEndIdentification (FSPIOP equivalent: transactionId) - - - Definition: Unique identification, as assigned by the initiating - party, to unambiguously identify the - - transaction. This identification is passed on, unchanged, - throughout the entire end-to-end chain. - - - Usage: The end-to-end identification can be used for - reconciliation or to link tasks relating to the - - transaction. It can be included in several messages related to - the transaction. - - - Usage: In case there are technical limitations to pass on - multiple references, the end-to-end - - identification must be passed on throughout the entire - end-to-end chain. - - - This field has been changed from the original ISO20022 - `Max35Text`` schema to a ULIDIdentifier schema. - TxId: - allOf: - - $ref: "#/components/schemas/ULIDIdentifier" - - description: > - 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. - - - Usage: The transaction identification can be used for - reconciliation, tracking or to link tasks relating to - - the transaction on the interbank level. - - - Usage: The instructing agent has to make sure that the - transaction identification is unique for a preagreed period. - - - This field has been changed from the original ISO20022 - `Max35Text`` schema to a ULIDIdentifier schema. - UETR: - allOf: - - $ref: "#/components/schemas/UUIDv4Identifier" - - description: > - UETR - - Universally unique identifier to provide an end-to-end reference - of a payment transaction. - ClrSysRef: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - ClearingSystemReference - - Unique reference, as assigned by a clearing system, to - unambiguously identify the instruction. - 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. + Provides further details specific to the individual transaction(s) included in the message. type: object properties: - StsId: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - Unique identification, as assigned by the original sending - party, to unambiguously identify the status report. - OrgnlInstrId: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - Unique identification, as assigned by the original sending - party, to - - unambiguously identify the original instruction. - - - (FSPIOP equivalent: transactionRequestId) - OrgnlEndToEndId: + PmtId: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - Unique identification, as assigned by the original sending - party, to - - unambiguously identify the original end-to-end transaction. - - - (FSPIOP equivalent: transactionId) - OrgnlTxId: + - $ref: '#/components/schemas/PaymentIdentification13' + - description: | + PaymentIdentification + Set of elements used to reference a payment instruction. + PmtTpInf: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - Unique identification, as assigned by the original sending - party, to - - unambiguously identify the original transaction. - - - (FSPIOP equivalent: quoteId) - OrgnlUETR: + - $ref: '#/components/schemas/PaymentTypeInformation28' + - description: | + PaymentTypeInformation + Set of elements used to further specify the type of transaction. + UndrlygCstmrCdtTrf: allOf: - - $ref: "#/components/schemas/UUIDv4Identifier" - - description: > - Unique end-to-end transaction reference, as assigned by the - original sending party, to unambiguously identify the original - transaction. - TxSts: + - $ref: '#/components/schemas/UnderlyingCustomerCreditTransfer' + - description: | + Underlying Customer Credit Transfer + TBD + IntrBkSttlmAmt: allOf: - - $ref: "#/components/schemas/ExternalPaymentTransactionStatus1Code" + - $ref: '#/components/schemas/ActiveCurrencyAndAmount' - description: | - Specifies the status of the transaction. - StsRsnInf: + InterbankSettlementAmount + Amount of money moved between the instructing agent and the instructed agent. + InstdAmt: allOf: - - $ref: "#/components/schemas/StatusReasonInformation14" + - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' - description: | - Information concerning the reason for the status. - AccptncDtTm: + 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. + XchgRate: allOf: - - $ref: "#/components/schemas/ISODateTime" + - $ref: '#/components/schemas/BaseOneRate' - description: | - Date and time at which the status was accepted. - AcctSvcrRef: + ExchangeRate + Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. + ChrgBr: + $ref: '#/components/schemas/ChargeBearerType1Code' + ChrgsInf: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - Unique reference, as assigned by the account servicing - institution, to unambiguously identify the status report. - ClrSysRef: + - $ref: '#/components/schemas/Charges16' + - description: | + ChargesInformation + Provides information on the charges to be paid by the charge bearer(s) related to the payment transaction. + Dbtr: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - Reference that is assigned by the account servicing institution - and sent to the account owner to unambiguously identify the - transaction. - ExctnConf: + - $ref: '#/components/schemas/PartyIdentification272' + - description: | + Debtor + Party that owes an amount of money to the (ultimate) creditor. + DbtrAcct: allOf: - - $ref: "#/components/schemas/Exact32HexBinaryText" - - description: > - Unique reference, as assigned by the account servicing - institution, to unambiguously identify the confirmation. - SplmtryData: + - $ref: '#/components/schemas/CashAccount40' + - description: | + DebtorAccount + Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. + DbtrAgt: allOf: - - $ref: "#/components/schemas/SupplementaryData1" - - description: > - Additional information that cannot be captured in the structured - elements and/or any other specific block. - PrcgDt: + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' + - description: | + DebtorAgent + Financial institution servicing an account for the debtor. + CdtrAgt: allOf: - - $ref: "#/components/schemas/DateAndDateTime2Choice" - - description: > - Date/time at which the instruction was processed by the - specified party. - 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. - type: object - properties: - InstrPrty: - $ref: "#/components/schemas/Priority2Code" - ClrChanl: - $ref: "#/components/schemas/ClearingChannel2Code" - SvcLvl: + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' + - description: | + CreditorAgent + Financial institution servicing an account for the creditor. + Cdtr: allOf: - - $ref: "#/components/schemas/ServiceLevel8Choice" - - description: > - ServiceLevel - - Agreement under which or rules under which the transaction - should be processed. - LclInstrm: + - $ref: '#/components/schemas/PartyIdentification272' + - description: | + Creditor + Party to which an amount of money is due. + CdtrAcct: allOf: - - $ref: "#/components/schemas/LocalInstrument2Choice" - - description: > - LocalInstrument - - Definition: User community specific instrument. - - Usage: This element is used to specify a local instrument, local - clearing option and/or further qualify the service or service - level. - CtgyPurp: + - $ref: '#/components/schemas/CashAccount40' + - description: | + CreditorAccount + Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. + InstrForCdtrAgt: allOf: - - $ref: "#/components/schemas/CategoryPurpose1Choice" - - description: > - CategoryPurpose - - Specifies the high level purpose of the instruction based on a - set of pre-defined categories. - 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. - type: object - properties: - DtAndPlcOfBirth: + - $ref: '#/components/schemas/InstructionForCreditorAgent3' + - description: | + InstructionForCreditorAgent + Set of elements used to provide information on the remittance advice. + InstrForNxtAgt: allOf: - - $ref: "#/components/schemas/DateAndPlaceOfBirth1" + - $ref: '#/components/schemas/InstructionForNextAgent1' - description: | - DateAndPlaceOfBirth - Date and place of birth of a person. - Othr: + InstructionForNextAgent + Set of elements used to provide information on the remittance advice. + Purp: allOf: - - $ref: "#/components/schemas/GenericPersonIdentification1" - - description: > - Other - - Unique identification of a person, as assigned by an - institution, using an identification scheme. - 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. - type: object - properties: - DtAndPlcOfBirth: + - $ref: '#/components/schemas/Purpose2Choice' + - description: | + Purpose + Underlying reason for the payment transaction. + RgltryRptg: allOf: - - $ref: "#/components/schemas/DateAndPlaceOfBirth1" + - $ref: '#/components/schemas/RegulatoryReporting3' - description: | - DateAndPlaceOfBirth - Date and place of birth of a person. - Othr: + RegulatoryReporting + Information needed due to regulatory and statutory requirements. + Tax: allOf: - - $ref: "#/components/schemas/GenericPersonIdentification2" - - description: > - Other - - Unique identification of a person, as assigned by an - institution, using an identification scheme. + - $ref: '#/components/schemas/TaxData1' + - description: | + Tax + Provides details on the tax. + VrfctnOfTerms: + $ref: '#/components/schemas/CryptographicLockChoice' + required: + - PmtId + - IntrBkSttlmAmt + - ChrgBr + - Dbtr + - DbtrAgt + - CdtrAgt + - Cdtr + - VrfctnOfTerms 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. + 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 + TermsResponse_FIToFICustomerCreditConfirmation: + title: TermsResponse_FIToFICustomerCreditConfirmation type: object - anyOf: - - properties: - Cd: - allOf: - - $ref: "#/components/schemas/ExternalPersonIdentification1Code" - - description: > - Code - - Name of the identification scheme, in a coded form as - published in an external list. - required: - - Cd - - properties: - Prtry: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: | - Proprietary - Name of the identification scheme, in a free text form. - required: - - Prtry - example: - Cd: CCPT - PhoneNumber: - title: PhoneNumber - type: string description: | - Double check this regex. - 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. - properties: - AdrTp: - $ref: "#/components/schemas/AddressType3Choice" - Dept: - $ref: "#/components/schemas/Max70Text" - SubDept: - $ref: "#/components/schemas/Max70Text" - StrtNm: - $ref: "#/components/schemas/Max70Text" - BldgNb: - $ref: "#/components/schemas/Max16Text" - BldgNm: - $ref: "#/components/schemas/Max35Text" - Flr: - $ref: "#/components/schemas/Max70Text" - PstBx: - $ref: "#/components/schemas/Max16Text" - Room: - $ref: "#/components/schemas/Max70Text" - PstCd: - $ref: "#/components/schemas/Max16Text" - TwnNm: - $ref: "#/components/schemas/Max35Text" - TwnLctnNm: - $ref: "#/components/schemas/Max35Text" - DstrctNm: - $ref: "#/components/schemas/Max35Text" - CtrySubDvsn: - $ref: "#/components/schemas/Max35Text" - Ctry: - $ref: "#/components/schemas/CountryCode" - AdrLine: - $ref: "#/components/schemas/Max70Text" - example: - AdrTp: ADDR - Dept: Dept - SubDept: SubDept - StrtNm: StrtNm - 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. + 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. properties: - AdrTp: - $ref: "#/components/schemas/AddressType3Choice" - CareOf: - $ref: "#/components/schemas/Max140Text" - Dept: - $ref: "#/components/schemas/Max70Text" - SubDept: - $ref: "#/components/schemas/Max70Text" - StrtNm: - $ref: "#/components/schemas/Max140Text" - BldgNb: - $ref: "#/components/schemas/Max16Text" - BldgNm: - $ref: "#/components/schemas/Max140Text" - Flr: - $ref: "#/components/schemas/Max70Text" - UnitNb: - $ref: "#/components/schemas/Max16Text" - PstBx: - $ref: "#/components/schemas/Max16Text" - Room: - $ref: "#/components/schemas/Max70Text" - PstCd: - $ref: "#/components/schemas/Max16Text" - TwnNm: - $ref: "#/components/schemas/Max140Text" - TwnLctnNm: - $ref: "#/components/schemas/Max140Text" - DstrctNm: - $ref: "#/components/schemas/Max140Text" - CtrySubDvsn: - $ref: "#/components/schemas/Max35Text" - Ctry: - $ref: "#/components/schemas/CountryCode" - AdrLine: - $ref: "#/components/schemas/Max70Text" + GrpHdr: + allOf: + - $ref: '#/components/schemas/GroupHeader129b' + - description: | + Group Header + Set of characteristics shared by all individual transactions included in the message. + CdtTrfTxInf: + allOf: + - $ref: '#/components/schemas/CreditTransferTransaction67b' + - description: | + Credit Transfer Transaction Information + Set of elements providing information specific to the individual credit transfer(s). + required: + - GrpHdr + - CdtTrfTxInf example: - AdrTp: ADDR - CareOf: CareOf - Dept: Dept - SubDept: SubDept - StrtNm: StrtNm - BldgNb: BldgNb - 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. - - - LETT: Letter - - MAIL: Email - - PHON: Phone - - FAXX: Fax - - CELL: Mobile phone - 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. - - LETT: Letter - - MAIL: Email - - PHON: Phone - - FAXX: Fax - - CELL: Mobile phone - 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 - - would like the instructed party to apply to the processing of the - instruction. - - - HIGH: High priority - - NORM: Normal priority - type: string - enum: - - HIGH - - NORM - example: HIGH - ProxyAccountIdentification1: - title: ProxyAccountIdentification1 + 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 + GroupHeader120: + title: GroupHeader120 description: | - Information related to a proxy identification of the account. + Set of characteristics shared by all individual transactions included in the message. type: object properties: - Tp: + MsgId: allOf: - - $ref: "#/components/schemas/ProxyAccountType1Choice" + - $ref: '#/components/schemas/Max35Text' - description: | - Type - Type of the proxy identification. - Id: + MessageIdentification + Definition: Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message. + Usage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period. + CreDtTm: allOf: - - $ref: "#/components/schemas/Max2048Text" - - description: > - Identification - - Identification used to indicate the account identification under - another specified name. + - $ref: '#/components/schemas/ISODateTime' + - description: | + CreationDateTime + Date and time at which the message was created. required: - - Id + - MsgId + - CreDtTm example: - Tp: - Cd: IBAN - Id: 123 - ProxyAccountType1Choice: - title: ProxyAccountType1Choice + MsgId: 12345 + CreDtTm: '2020-01-01T00:00:00Z' + ExternalPaymentTransactionStatus1Code: + title: ExternalPaymentTransactionStatus1Code description: | - Specifies the type of the proxy account. - type: object - anyOf: - - properties: - Cd: - allOf: - - $ref: "#/components/schemas/ExternalProxyAccountType1Code" - - description: > - Code - - Proxy account type, in a coded form as published in an - external list. - required: - - Cd - - properties: - Prtry: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: | - Proprietary - Proxy account type, in a proprietary form. - required: - - Prtry - example: - Cd: EMAIL - Purpose2Choice: - title: Purpose2Choice - description: > - Specifies the underlying reason for the payment transaction. - - - Usage: Purpose is used by the end-customers, that is initiating party, - - (ultimate) debtor, (ultimate) creditor to provide information concerning - the nature of the payment. Purpose + Specifies the external payment transaction status code. - is a content element, which is not used for processing by any of the - agents involved in the payment + For FSPIOP transfer state enumeration mappings: + { + "COMM": "COMMITED", + "RESV": "RESERVED", + "RECV": "RECEIVED", + "ABOR": "ABORTED" + } - chain. + NOTE: enum enforcement is not apart of the ISO20022 specification, but is added here for FSPIOP mappings. + type: string + minLength: 1 + maxLength: 4 + example: COMM + enum: + - COMM + - RESV + - RECV + - ABOR + ExternalStatusReason1Code: + title: ExternalStatusReason1Code + description: Specifies the external status reason code. + type: string + minLength: 1 + maxLength: 4 + example: 1234 + StatusReason6Choice: + title: StatusReason6Choice + description: | + Specifies the reason for the status. type: object anyOf: - properties: Cd: allOf: - - $ref: "#/components/schemas/ExternalPurpose1Code" - - description: > + - $ref: '#/components/schemas/ExternalStatusReason1Code' + - description: | Code - - - Underlying reason for the payment transaction, as published - in an external purpose code list. + Reason for the status, as published in an external reason code list. required: - Cd - properties: Prtry: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/Max35Text' - description: | Proprietary - - Purpose, in a proprietary form. + Reason for the status, in a proprietary form. required: - Prtry example: - Cd: CH03 - RegulatoryAuthority2: - title: RegulatoryAuthority2 - description: > - Information about an entity requiring the regulatory reporting - information. - type: object - properties: - Nm: - allOf: - - $ref: "#/components/schemas/Max140Text" - - description: > - Name - - - Name of the entity requiring the regulatory reporting - information. - Ctry: - allOf: - - $ref: "#/components/schemas/CountryCode" - - description: > - Country - - - Country of the entity that requires the regulatory reporting - information. - example: - Nm: Swiss National Bank - Ctry: CH - RegulatoryReporting3: - title: RegulatoryReporting3 + Cd: AGNT + Max105Text: + title: Max105Text description: | - Information needed due to regulatory and/or statutory requirements. + Specifies a character string with a maximum length of 105 characters. + type: string + minLength: 1 + maxLength: 105 + example: 12345 + StatusReasonInformation14b: + title: StatusReasonInformation14 + description: | + Unsure on description. type: object properties: - DbtCdtRptgInd: + Orgtr: allOf: - - $ref: "#/components/schemas/RegulatoryReportingType1Code" - - description: > - DebitCreditReportingIndicator - - Identifies whether the regulatory reporting information applies - to the debit side, to the credit side or to both debit and - credit sides of the transaction. - Authrty: + - $ref: '#/components/schemas/PartyIdentification272' + - description: | + Originator + Party that issues the status. + Rsn: allOf: - - $ref: "#/components/schemas/RegulatoryAuthority2" + - $ref: '#/components/schemas/StatusReason6Choice' - description: | - Authority - - Entity requiring the regulatory reporting information. - Dtls: - description: > - Details - - Identifies whether the regulatory reporting information applies to - the debit side, to the credit side or to both debit and credit sides - of the transaction. - anyOf: - - $ref: "#/components/schemas/StructuredRegulatoryReporting3" - - items: - $ref: "#/components/schemas/StructuredRegulatoryReporting3" - type: array + Reason + Specifies the reason for the status report. + AddtlInf: + allOf: + - $ref: '#/components/schemas/Max105Text' + - description: | + AdditionalInformation + Additional information about the status report. + required: + - Rsn 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 - - side, to the credit side or to both debit and credit sides of the - transaction. - - - CRED: Regulatory reporting applies to the credit side of the - transaction. - - DEBT: Regulatory reporting applies to the debit side of the transaction. - - BOTH: Regulatory reporting applies to both debit and credit sides of the - transaction. - type: string - enum: - - CRED - - DEBT - - BOTH - example: BOTH - ServiceLevel8Choice: - title: ServiceLevel8Choice + 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 + DateAndDateTime2Choice: + title: StatusReason6Choice description: | - Details about a service level. + Specifies the reason for the status. type: object anyOf: - properties: - Cd: + Dt: allOf: - - $ref: "#/components/schemas/ExternalServiceLevel1Code" - - description: > - Code - - Specifies a pre-agreed service or level of service between - the parties, as published in an external service level code - list. + - $ref: '#/components/schemas/ISODate' + - description: | + Date + Specified date. required: - - Cd + - Dt - properties: - Prtry: + DtTm: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - Proprietary - - Specifies a pre-agreed service or level of service between - the parties, as a proprietary code. + - $ref: '#/components/schemas/ISODateTime' + - description: | + DateTime + Specified date and time. required: - - Prtry + - DtTm example: - Cd: SEPA - SettlementInstruction15: - title: SettlementInstruction15 - description: > - Specifies the details on how the settlement of the original - transaction(s) between the + DtTm: '2020-01-01T00:00:00Z' + PaymentTransaction163b: + title: PaymentTransaction163 + description: | + Provides further details on the original transactions, to which the status report message refers. + type: object + properties: + StsId: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Unique identification, as assigned by the original sending party, to unambiguously identify the status report. + OrgnlInstrId: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Unique identification, as assigned by the original sending party, to + unambiguously identify the original instruction. - instructing agent and the instructed agent was completed. + (FSPIOP equivalent: transactionRequestId) + OrgnlEndToEndId: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Unique identification, as assigned by the original sending party, to + unambiguously identify the original end-to-end transaction. + + (FSPIOP equivalent: transactionId) + OrgnlTxId: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Unique identification, as assigned by the original sending party, to + unambiguously identify the original transaction. + + (FSPIOP equivalent: quoteId) + OrgnlUETR: + allOf: + - $ref: '#/components/schemas/UUIDv4Identifier' + - description: | + Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction. + TxSts: + allOf: + - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' + - description: | + Specifies the status of the transaction. + StsRsnInf: + allOf: + - $ref: '#/components/schemas/StatusReasonInformation14b' + - description: | + Information concerning the reason for the status. + AccptncDtTm: + allOf: + - $ref: '#/components/schemas/ISODateTime' + - description: | + Date and time at which the status was accepted. + AcctSvcrRef: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report. + ClrSysRef: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction. + ExctnConf: + allOf: + - $ref: '#/components/schemas/Exact32HexBinaryText' + - description: | + Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation. + SplmtryData: + allOf: + - $ref: '#/components/schemas/SupplementaryData1' + - 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. + required: + - StsRsnInf + 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 + 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. properties: - SttlmMtd: - $ref: "#/components/schemas/SettlementMethod1Code" - PmtTpInf: - $ref: "#/components/schemas/PaymentTypeInformation28" + GrpHdr: + allOf: + - $ref: '#/components/schemas/GroupHeader120' + - description: | + Set of characteristics shared by all individual transactions included in the message. + TxInfAndSts: + allOf: + - $ref: '#/components/schemas/PaymentTransaction163b' + - 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 + - TxInfAndSts + example: + GrpHdr: + MsgId: 12345 + CreDtTm: '2020-01-01T00:00:00Z' + NbOfTxs: 1 + SttlmInf: + SttlmMtd: CLRG + 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 + Execute_FIToFICustomerCreditTransferV13: + title: Execute_FIToFICustomerCreditTransferV13 + type: object + properties: + GrpHdr: + allOf: + - $ref: '#/components/schemas/GroupHeader129b' + - description: | + Group Header + Set of characteristics shared by all individual transactions included in the message. + CdtTrfTxInf: + allOf: + - $ref: '#/components/schemas/CreditTransferTransaction67b' + - description: | + Credit Transfer Transaction Information + Set of elements providing information specific to the individual credit transfer(s). required: - - SttlmMtd + - GrpHdr + - CdtTrfTxInf example: - SttlmMtd: INDA - PmtTpInf: - InstrPrty: NORM - SvcLvl: - Cd: SEPA - LclInstrm: - Cd: CH03 - CtgyPurp: - Cd: SUPP + GrpHdr: + MsgId: 12345 + CreDtTm: '2020-01-01T00:00:00Z' + PmtInstrXpryDtTm: '2020-01-01T00:00:00Z' + NbOfTxs: 1 + SttlmInf: + SttlmMtd: CLRG + SttlmAcct: + Id: + IBAN: 123 + SttlmAcctOwnr: + Nm: John Doe + SttlmAcctSvcr: + BICFI: 123 + CdtTrfTxInf: + PmtId: + InstrId: 123 + EndToEndId: 123 + PmtTpInf: + InstrPrty: NORM + InstdAmt: + Amt: 123 + Ccy: EUR + ChrgBr: SHAR + CdtrAgt: + FinInstnId: + BICFI: 123 Cdtr: - Nm: Name - PstlAdr: - AdrTp: ADDR - AdrLine: Address - Ctry: CH + Nm: John Doe + CdtrAcct: 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. - - INDA: Indirect Account - INGA: Indirect Agent - COVE: Cover - CLRG: Clearing - type: string - enum: - - INDA - - INGA - - COVE - - CLRG - example: CLRG - StatusReason6Choice: - title: StatusReason6Choice - description: | - Specifies the reason for the status. - type: object - anyOf: - - properties: - Cd: - allOf: - - $ref: "#/components/schemas/ExternalStatusReason1Code" - - description: > - Code - - Reason for the status, as published in an external reason - code list. - required: - - Cd - - properties: - Prtry: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: | - Proprietary - Reason for the status, in a proprietary form. - required: - - Prtry - example: - Cd: AGNT + IBAN: 123 + RmtInf: + Ustrd: Test StatusReasonInformation14: title: StatusReasonInformation14 description: | @@ -6339,19 +6249,19 @@ components: properties: Orgtr: allOf: - - $ref: "#/components/schemas/PartyIdentification272" + - $ref: '#/components/schemas/PartyIdentification272' - description: | Originator Party that issues the status. Rsn: allOf: - - $ref: "#/components/schemas/StatusReason6Choice" + - $ref: '#/components/schemas/StatusReason6Choice' - description: | Reason Specifies the reason for the status report. AddtlInf: allOf: - - $ref: "#/components/schemas/Max105Text" + - $ref: '#/components/schemas/Max105Text' - description: | AdditionalInformation Additional information about the status report. @@ -6371,881 +6281,955 @@ components: Rsn: Cd: AGNT AddtlInf: AdditionalInformation - StructuredRegulatoryReporting3: - title: StructuredRegulatoryReporting3 + PaymentTransaction163: + title: PaymentTransaction163 description: | - StructuredRegulatoryReporting3 - - Information needed due to regulatory and statutory requirements. + Provides further details on the original transactions, to which the status report message refers. type: object properties: - Tp: + StsId: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - Type - - - Specifies the type of the information supplied in the regulatory - reporting details. - Dt: + - $ref: '#/components/schemas/Max35Text' + - description: | + Unique identification, as assigned by the original sending party, to unambiguously identify the status report. + OrgnlInstrId: allOf: - - $ref: "#/components/schemas/ISODate" - - description: > - Date - + - $ref: '#/components/schemas/Max35Text' + - description: | + Unique identification, as assigned by the original sending party, to + unambiguously identify the original instruction. - Date related to the specified type of regulatory reporting - details. - Ctry: + (FSPIOP equivalent: transactionRequestId) + OrgnlEndToEndId: allOf: - - $ref: "#/components/schemas/CountryCode" - - description: > - Country - + - $ref: '#/components/schemas/Max35Text' + - description: | + Unique identification, as assigned by the original sending party, to + unambiguously identify the original end-to-end transaction. - Country related to the specified type of regulatory reporting - details. - Cd: + (FSPIOP equivalent: transactionId) + OrgnlTxId: allOf: - - $ref: "#/components/schemas/Max10Text" - - description: > - Code + - $ref: '#/components/schemas/Max35Text' + - description: | + Unique identification, as assigned by the original sending party, to + unambiguously identify the original transaction. - Specifies the nature, purpose, and reason for the transaction to - be reported for regulatory and statutory requirements in a coded - form. - Amt: + (FSPIOP equivalent: quoteId) + OrgnlUETR: allOf: - - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" - - description: > - Amount - - - Amount of money to be reported for regulatory and statutory - requirements. - Inf: - description: > - Information - - - Additional details that cater for specific domestic regulatory - requirements. - anyOf: - - $ref: "#/components/schemas/Max35Text" - - items: - $ref: "#/components/schemas/Max35Text" - type: array + - $ref: '#/components/schemas/UUIDv4Identifier' + - description: | + Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction. + TxSts: + allOf: + - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' + - description: | + Specifies the status of the transaction. + StsRsnInf: + allOf: + - $ref: '#/components/schemas/StatusReasonInformation14' + - description: | + Information concerning the reason for the status. + AccptncDtTm: + allOf: + - $ref: '#/components/schemas/ISODateTime' + - description: | + Date and time at which the status was accepted. + AcctSvcrRef: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report. + ClrSysRef: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction. + ExctnConf: + allOf: + - $ref: '#/components/schemas/Exact32HexBinaryText' + - description: | + Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation. + SplmtryData: + allOf: + - $ref: '#/components/schemas/SupplementaryData1' + - 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. + required: + - ExctnConf + - PrcgDt + - TxSts 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. + 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 + 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: - PlcAndNm: + GrpHdr: + allOf: + - $ref: '#/components/schemas/GroupHeader120' + - description: | + Set of characteristics shared by all individual transactions included in the message. + 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 + - TxInfAndSts + 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 + PaymentTransaction163patch: + title: PaymentTransaction163 + description: | + Provides further details on the original transactions, to which the status report message refers. + type: object + properties: + StsId: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Unique identification, as assigned by the original sending party, to unambiguously identify the status report. + OrgnlInstrId: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Unique identification, as assigned by the original sending party, to + unambiguously identify the original instruction. + + (FSPIOP equivalent: transactionRequestId) + OrgnlEndToEndId: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Unique identification, as assigned by the original sending party, to + unambiguously identify the original end-to-end transaction. + + (FSPIOP equivalent: transactionId) + OrgnlTxId: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Unique identification, as assigned by the original sending party, to + unambiguously identify the original transaction. + + (FSPIOP equivalent: quoteId) + OrgnlUETR: + allOf: + - $ref: '#/components/schemas/UUIDv4Identifier' + - description: | + Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction. + TxSts: + allOf: + - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' + - description: | + Specifies the status of the transaction. + StsRsnInf: + allOf: + - $ref: '#/components/schemas/StatusReasonInformation14b' + - description: | + Information concerning the reason for the status. + AccptncDtTm: allOf: - - $ref: "#/components/schemas/Max350Text" - - description: > - PlaceAndName - - Unambiguous reference to the location where the supplementary - data must be inserted in the message instance. - Envlp: + - $ref: '#/components/schemas/ISODateTime' + - description: | + Date and time at which the status was accepted. + AcctSvcrRef: allOf: - - $ref: "#/components/schemas/SupplementaryDataEnvelope1" - - description: > - Envelope - - Technical element wrapping the supplementary data. - - Technical component that contains the validated supplementary - data information. This technical envelope allows to segregate - the supplementary data information from any other information. + - $ref: '#/components/schemas/Max35Text' + - description: | + Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report. + ClrSysRef: + allOf: + - $ref: '#/components/schemas/Max35Text' + - description: | + Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction. + ExctnConf: + allOf: + - $ref: '#/components/schemas/Exact32HexBinaryText' + - description: | + Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation. + SplmtryData: + allOf: + - $ref: '#/components/schemas/SupplementaryData1' + - 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. required: - - Envlp + - PrcgDt + - TxSts example: - PlcAndNm: Additional information - Envlp: - Cd: CH03 - Prtry: Additional information - SupplementaryDataEnvelope1: - title: SupplementaryDataEnvelope1 - description: > - SupplementaryDataEnvelope1 - - Technical component that contains the validated supplementary data - information. This technical envelope allows to segregate the - supplementary data information from any other information. - type: object - TaxAmount3: - title: TaxAmount3 - description: | - Information on the amount of the tax record. + 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 + PacsStatus_FIToFIPaymentStatusReportV15patch: + 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: - Rate: + GrpHdr: allOf: - - $ref: "#/components/schemas/PercentageRate" + - $ref: '#/components/schemas/GroupHeader120' - description: | - Rate - - Rate used to calculate the tax. - TaxblBaseAmt: + Set of characteristics shared by all individual transactions included in the message. + TxInfAndSts: allOf: - - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" + - $ref: '#/components/schemas/PaymentTransaction163patch' - description: | - TaxableBaseAmount - - Amount of money on which the tax is based. - TtlAmt: + Information concerning the original transactions, to which the status report message refers. + SplmtryData: allOf: - - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" - - description: > - TotalAmount - - - Total amount that is the result of the calculation of the tax - for the record. - Dtls: - description: > - Details - - - Set of elements used to provide details on the tax period and - amount. - anyOf: - - $ref: "#/components/schemas/TaxRecordDetails3" - - items: - $ref: "#/components/schemas/TaxRecordDetails3" - type: array + - $ref: '#/components/schemas/SupplementaryData1' + - description: | + Additional information that cannot be captured in the structured elements and/or any other specific block. + required: + - GrpHdr + - TxInfAndSts 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 + 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 + AmountTypeEnum: + title: AmountTypeEnum description: | - Details of an authorised tax paying party. + NOTE: This pattern is not the original ISO20022 specification. + This represents the enum values when mapping to and from FSPIOP specification. + type: string + enum: + - SEND + - RECEIVE + example: SEND + InstructionForCreditorAgent3_FX_Quotes: + title: InstructionForCreditorAgent3_Put_FX_Quotes_ID + description: | + Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent. type: object properties: - Titl: + Cd: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - Title - - - Title or position of debtor or the debtor's authorised - representative. - Nm: + - $ref: '#/components/schemas/ExternalCreditorAgentInstruction1Code' + - description: | + Code + Coded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent. + InstrInf: allOf: - - $ref: "#/components/schemas/Max140Text" + - $ref: '#/components/schemas/AmountTypeEnum' - description: | - Name - - Name of the debtor or the debtor's authorised representative. + InstructionInformation + Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community. 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. + Cd: PHOA + InstrInf: Please advise/contact next agent by phone. + CreditTransferTransaction68_FX_Quotes: + title: CreditTransferTransaction68_FX_Quotes + description: | + Provides further details specific to the individual transaction(s) included in the message. type: object properties: - Cdtr: - allOf: - - $ref: "#/components/schemas/TaxParty1" - - description: > - Creditor - - - Party on the credit side of the transaction to which the tax - applies. - Dbtr: - allOf: - - $ref: "#/components/schemas/TaxParty2" - - description: > - Debtor - - - Party on the debit side of the transaction to which the tax - applies. - UltmtDbtr: - allOf: - - $ref: "#/components/schemas/TaxParty2" - - description: > - UltimateDebtor - - - Ultimate party that owes an amount of money to the (ultimate) - creditor, in this case, to the taxing authority. - AdmstnZone: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - AdministrationZone - - - Territorial part of a country to which the tax payment is - related. - RefNb: + PmtId: allOf: - - $ref: "#/components/schemas/Max140Text" + - $ref: '#/components/schemas/PaymentIdentification13' - description: | - ReferenceNumber - - Tax reference information that is specific to a taxing agency. - Mtd: + PaymentIdentification + Set of elements used to reference a payment instruction. + PmtTpInf: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - Method - - - Method used to indicate the underlying business or how the tax - is paid. - TtlTaxblBaseAmt: + - $ref: '#/components/schemas/PaymentTypeInformation28' + - description: | + PaymentTypeInformation + Set of elements used to further specify the type of transaction. + UndrlygCstmrCdtTrf: allOf: - - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" + - $ref: '#/components/schemas/UnderlyingCustomerCreditTransfer' - description: | - TotalTaxableBaseAmount - - Total amount of money on which the tax is based. - TtlTaxAmt: + Underlying Customer Credit Transfer + TBD + IntrBkSttlmAmt: allOf: - - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" + - $ref: '#/components/schemas/ActiveCurrencyAndAmount' - description: | - TotalTaxAmount - - Total amount of money as result of the calculation of the tax. - Dt: + InterbankSettlementAmount + Amount of money moved between the instructing agent and the instructed agent. + Dbtr: allOf: - - $ref: "#/components/schemas/ISODate" + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' - description: | - Date - - Date by which tax is due. - SeqNb: + Debtor + Party that owes an amount of money to the (ultimate) creditor. + DbtrAcct: allOf: - - $ref: "#/components/schemas/Number" + - $ref: '#/components/schemas/CashAccount40' - description: | - SequenceNumber - - Sequential number of the tax report. - Rcrd: - description: | - Record - - Details of the tax record. - anyOf: - - $ref: "#/components/schemas/TaxRecord3" - - items: - $ref: "#/components/schemas/TaxRecord3" - 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. - type: object - properties: - TaxId: + DebtorAccount + Account used to process a payment. + DbtrAgt: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' - description: | - TaxIdentification - - Tax identification number of the creditor. - RegnId: + DebtorAgent + Financial institution servicing an account for the debtor. + CdtrAgt: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - RegistrationIdentification - - - Unique identification, as assigned by an organisation, to - unambiguously identify a party. - TaxTp: + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' + - description: | + CreditorAgent + Financial institution servicing an account for the creditor. + Cdtr: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' - description: | - TaxType - - Type of tax payer. - example: - TaxId: 123456789 - RegnId: 123456789 - TaxTp: VAT - TaxParty2: - title: TaxParty2 - description: | - Details about the entity involved in the tax paid or to be paid. - type: object - properties: - TaxId: + Creditor + Party to which an amount of money is due. + CdtrAcct: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/CashAccount40' - description: | - TaxIdentification - - Tax identification number of the debtor. - RegnId: + CreditorAccount + Account to which a credit entry is made. + InstrForCdtrAgt: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - RegistrationIdentification - - - Unique identification, as assigned by an organisation, to - unambiguously identify a party. - TaxTp: + - $ref: '#/components/schemas/InstructionForCreditorAgent3_FX_Quotes' + - description: | + InstructionForCreditorAgent + Set of elements used to provide information on the remittance advice. + Purp: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/Purpose2Choice' - description: | - TaxType - - Type of tax payer. - Authstn: + Purpose + Underlying reason for the payment transaction. + VrfctnOfTerms: allOf: - - $ref: "#/components/schemas/TaxAuthorisation1" + - $ref: '#/components/schemas/CryptographicLockChoice' - description: | - Authorisation - - Details of the authorised tax paying party. + VerificationOfTerms + Set of elements used to provide information on the underlying terms of the transaction. + required: + - PmtId + - IntrBkSttlmAmt + - UndrlygCstmrCdtTrf + - Dbtr + - Cdtr + - InstrForCdtrAgt 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. + 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 + FxRequest_FICreditTransferProposal: + title: FxRequest_FICreditTransferProposal type: object + description: | + FxRequest_FICreditTransferProposal + A group of elements providing information specific to the individual credit transfer(s) included in the message. properties: - FrToDt: - allOf: - - $ref: "#/components/schemas/DatePeriod2" - - description: > - FromToDate - - - Range of time between a start date and an end date for which the - tax report is provided. - Tp: + GrpHdr: allOf: - - $ref: "#/components/schemas/TaxRecordPeriod1Code" + - $ref: '#/components/schemas/GroupHeader129b' - description: | - Type - - Identification of the period related to the tax payment. - Yr: + GroupHeader + Set of characteristics shared by all individual transactions included in the message. + CdtTrfTxInf: allOf: - - $ref: "#/components/schemas/ISOYear" + - $ref: '#/components/schemas/CreditTransferTransaction68_FX_Quotes' - description: | - Year - - Year related to the tax payment. + Credit Transfer Transaction Information + required: + - GrpHdr + - CdtTrfTxInf example: - Yr: 2020 - Tp: MM01 - FrToDt: - FrDt: "2020-01-01" - ToDt: "2020-01-31" - TaxRecord3: - title: TaxRecord3 + GrpHdr: + MsgId: 12345 + CreDtTm: '2020-01-01T00:00:00Z' + NbOfTxs: 1 + TtlIntrBkSttlmAmt: + Ccy: EUR + Value: 100 + SttlmInf: + SttlmMtd: CLRG + 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 + CreditTransferTransaction68_FX_Quotesb: + title: CreditTransferTransaction68_FX_Quotes description: | - Set of elements used to define the tax record. + Provides further details specific to the individual transaction(s) included in the message. type: object properties: - AddtlInf: + PmtId: allOf: - - $ref: "#/components/schemas/Max140Text" + - $ref: '#/components/schemas/PaymentIdentification13' - description: | - AdditionalInformation - - Further details of the tax record. - CertId: + PaymentIdentification + Set of elements used to reference a payment instruction. + PmtTpInf: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - CertificateIdentification - - - Identification number of the tax report as assigned by the - taxing authority. - Ctgy: + - $ref: '#/components/schemas/PaymentTypeInformation28' + - description: | + PaymentTypeInformation + Set of elements used to further specify the type of transaction. + UndrlygCstmrCdtTrf: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/UnderlyingCustomerCreditTransfer' - description: | - Category - - Specifies the tax code as published by the tax authority. - CtgyDtls: + Underlying Customer Credit Transfer + TBD + IntrBkSttlmAmt: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/ActiveCurrencyAndAmount' - description: | - CategoryDetails - - Provides further details of the category tax code. - DbtrSts: + InterbankSettlementAmount + Amount of money moved between the instructing agent and the instructed agent. + Dbtr: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - DebtorStatus - - - Code provided by local authority to identify the status of the - party that has drawn up the settlement document. - FrmsCd: + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' + - description: | + Debtor + Party that owes an amount of money to the (ultimate) creditor. + DbtrAcct: allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - FormsCode - - - Identifies, in a coded form, on which template the tax report is - to be provided. - Prd: + - $ref: '#/components/schemas/CashAccount40' + - description: | + DebtorAccount + Account used to process a payment. + DbtrAgt: + allOf: + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' + - description: | + DebtorAgent + Financial institution servicing an account for the debtor. + CdtrAgt: allOf: - - $ref: "#/components/schemas/TaxPeriod3" - - description: > - Period - - - Set of elements used to provide details on the period of time - related to the tax payment. - TaxAmt: + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' + - description: | + CreditorAgent + Financial institution servicing an account for the creditor. + Cdtr: allOf: - - $ref: "#/components/schemas/TaxAmount3" - - description: > - TaxAmount - - - Set of elements used to provide information on the amount of the - tax record. - Tp: + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' + - description: | + Creditor + Party to which an amount of money is due. + CdtrAcct: allOf: - - $ref: "#/components/schemas/Max35Text" + - $ref: '#/components/schemas/CashAccount40' - description: | - Type - - High level code to identify the type of tax details. - 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. - type: object - properties: - Prd: + CreditorAccount + Account to which a credit entry is made. + InstrForCdtrAgt: allOf: - - $ref: "#/components/schemas/TaxPeriod3" - - description: > - Period - - - Set of elements used to provide details on the period of time - related to the tax payment. - Amt: + - $ref: '#/components/schemas/InstructionForCreditorAgent3_FX_Quotes' + - description: | + InstructionForCreditorAgent + Set of elements used to provide information on the remittance advice. + Purp: allOf: - - $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" + - $ref: '#/components/schemas/Purpose2Choice' - description: | - Amount - - Underlying tax amount related to the specified period. + Purpose + Underlying reason for the payment transaction. + VrfctnOfTerms: + allOf: + - $ref: '#/components/schemas/CryptographicLockChoice' + - description: | + VerificationOfTerms + Set of elements used to provide information on the underlying terms of the transaction. required: - - Amt + - PmtId + - IntrBkSttlmAmt + - UndrlygCstmrCdtTrf + - Dbtr + - Cdtr + - VrfctnOfTerms + - InstrForCdtrAgt example: - Prd: - Yr: 2020 - Tp: MM01 - FrToDt: - FrDt: "2020-01-01" - ToDt: "2020-01-31" - Amt: - Amt: 100 + PmtId: + InstrId: INSTRID + EndToEndId: ENDTOENDID + PmtTpInf: + LclInstrm: + Cd: CHQB + Prtry: PROPRIETARY + IntrBkSttlmAmt: + Amount: 123.45 Ccy: EUR - TaxRecordPeriod1Code: - title: TaxRecordPeriod1Code - description: | - Specifies the period related to the tax payment - - MM01 FirstMonth Tax is related to the second month of the period. - MM02 SecondMonth Tax is related to the first month of the period. - MM03 ThirdMonth Tax is related to the third month of the period. - MM04 FourthMonth Tax is related to the fourth month of the period. - MM05 FifthMonth Tax is related to the fifth month of the period. - MM06 SixthMonth Tax is related to the sixth month of the period. - MM07 SeventhMonth Tax is related to the seventh month of the period. - MM08 EighthMonth Tax is related to the eighth month of the period. - MM09 NinthMonth Tax is related to the ninth month of the period. - MM10 TenthMonth Tax is related to the tenth month of the period. - MM11 EleventhMonth Tax is related to the eleventh month of the period. - MM12 TwelfthMonth Tax is related to the twelfth month of the period. - QTR1 FirstQuarter Tax is related to the first quarter of the period. - QTR2 SecondQuarter Tax is related to the second quarter of the period. - QTR3 ThirdQuarter Tax is related to the third quarter of the period. - QTR4 FourthQuarter Tax is related to the forth quarter of the period. - HLF1 FirstHalf Tax is related to the first half of the period. - HLF2 SecondHalf Tax is related to the second half of the period. - 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 + 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 + FxResponse_FICreditTransferConfirmation: + title: FxResponse_FICreditTransferConfirmation 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. + description: | + FxResponse_FICreditTransferConfirmation + The FxResponse_FICreditTransferConfirmation message is sent by the FSP to the Payer FSP to confirm the successful processing of the credit transfer. properties: GrpHdr: allOf: - - $ref: "#/components/schemas/GroupHeader129" - - description: > - Group Header - - Set of characteristics shared by all individual transactions - included in the message. + - $ref: '#/components/schemas/GroupHeader129b' + - description: | + GroupHeader + Set of characteristics shared by all individual transactions included in the message. CdtTrfTxInf: allOf: - - $ref: "#/components/schemas/CreditTransferTransaction67" + - $ref: '#/components/schemas/CreditTransferTransaction68_FX_Quotesb' - description: | - Credit Transfer Transaction Information + CreditTransferTransaction68_FX_Quotes + Set of elements providing information specific to the individual credit transfer(s). required: - GrpHdr - CdtTrfTxInf example: GrpHdr: - MsgId: 123456789 - CreDtTm: "2020-01-01T00:00:00Z" + MsgId: 20191122-123456 + CreDtTm: '2019-11-22T12:34:56' NbOfTxs: 1 CtrlSum: 100 InitgPty: Nm: Initiating Party Name + MsgRcpt: + Nm: Message Recipient Name + CdtTrfTxInf: + PmtId: + InstrId: 20191122-123456 + EndToEndId: 20191122-123456 + PmtTpInf: + InstrPrty: NORM + CtgyPurp: SUPP + IntrBkSttlmAmt: + Amt: 100 + Ccy: EUR + ChrgBr: SHAR + Cdtr: + Nm: Creditor Name + CdtrAcct: Id: - OrgId: - Othr: - - Id: 123456789 - SchmeNm: - Cd: BBA - Prtry: Party Identification Scheme Name - FwdgAgt: + IBAN: BE71096123456769 + Tp: + Cd: CACC + Ccy: EUR + Nm: My account + CdtrAgt: 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. - properties: - GrpHdr: - allOf: - - $ref: "#/components/schemas/GroupHeader129" - - description: > - Group Header - - Set of characteristics shared by all individual transactions - included in the message. - CdtTrfTxInf: - allOf: - - $ref: "#/components/schemas/CreditTransferTransaction67" - - description: > - Credit Transfer Transaction Information - - Set of elements providing information specific to the individual - credit transfer(s). - required: - - GrpHdr - - CdtTrfTxInf - example: - GrpHdr: - MsgId: 123456789 - CreDtTm: "2020-01-01T00:00:00Z" - NbOfTxs: 1 - CtrlSum: 100 - InitgPty: - Nm: Initiating Party Name + BICFI: BNBABEBB + CdtrAgtAcct: Id: - OrgId: - Othr: - - Id: 123456789 - SchmeNm: - Cd: BBA - Prtry: Party Identification Scheme Name - FwdgAgt: + 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: BBBBBBBB - ULIDIdentifier: - title: ULIDIdentifier - type: string - pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ - example: 01AN4Z07BY79KA1307SR9X4MV3 - UUIDv4Identifier: - title: UUIDv4Identifier - type: string - example: 8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e - pattern: >- - ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ - UnderlyingCustomerCreditTransfer: - title: UnderlyingCustomerCreditTransfer + 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 + CreditTransferTransaction68: + title: CreditTransferTransaction68 + description: | + Provides further details specific to the individual transaction(s) included in the message. type: object properties: - InstdAmt: + PmtId: 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. + - $ref: '#/components/schemas/PaymentIdentification13' + - description: | + PaymentIdentification + Set of elements used to reference a payment instruction. + PmtTpInf: + allOf: + - $ref: '#/components/schemas/PaymentTypeInformation28' + - 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' + - description: | + InterbankSettlementAmount + Amount of money moved between the instructing agent and the instructed agent. Dbtr: allOf: - - $ref: "#/components/schemas/PartyIdentification272" + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' - description: | + Debtor Party that owes an amount of money to the (ultimate) creditor. - Cdtr: + DbtrAcct: allOf: - - $ref: "#/components/schemas/PartyIdentification272" + - $ref: '#/components/schemas/CashAccount40' - description: | - Party to which an amount of money is due. + DebtorAccount + Account used to process a payment. DbtrAgt: allOf: - - $ref: >- - #/components/schemas/BranchAndFinancialInstitutionIdentification8 + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' - description: | + DebtorAgent Financial institution servicing an account for the debtor. CdtrAgt: allOf: - - $ref: >- - #/components/schemas/BranchAndFinancialInstitutionIdentification8 + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' - description: | + CreditorAgent Financial institution servicing an account for the creditor. + Cdtr: + allOf: + - $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification8' + - description: | + Creditor + Party to which an amount of money is due. + CdtrAcct: + allOf: + - $ref: '#/components/schemas/CashAccount40' + - description: | + CreditorAccount + Account to which a credit entry is made. + InstrForCdtrAgt: + allOf: + - $ref: '#/components/schemas/InstructionForCreditorAgent3' + - description: | + InstructionForCreditorAgent + Set of elements used to provide information on the remittance advice. + Purp: + allOf: + - $ref: '#/components/schemas/Purpose2Choice' + - description: | + Purpose + Underlying reason for the payment transaction. + VrfctnOfTerms: + allOf: + - $ref: '#/components/schemas/CryptographicLockChoice' + - description: | + VerificationOfTerms + Set of elements used to provide information on the underlying terms of the transaction. required: + - PmtId + - IntrBkSttlmAmt - Dbtr - Cdtr - - DbtrAgt - - CdtrAgt - VerificationReason1Choice: - title: VerificationReason1Choice - type: object - description: | - Choice of format for the verification reason. - Only one, between the coded and the proprietary, can be chosen. - anyOf: - - properties: - Cd: - allOf: - - $ref: "#/components/schemas/ExternalVerificationReason1Code" - - description: > - Code - - Reason why the verified identification information is - incorrect, as published in an external reason code list. - required: - - Cd - - properties: - Prtry: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - Proprietary - - Reason why the verified identification information is - incorrect, in a free text form. - required: - - Prtry + - UndrlygCstmrCdtTrf + - VrfctnOfTerms example: - Cd: AGNT - VerificationReport4: - title: VerificationReport4 + 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 + Fxecute_FinancialInstitutionCreditTransferV12: + title: Fxecute_FinancialInstitutionCreditTransferV12 type: object - description: >- - VerificationReport - - Provides information about the verification of party and/or account - identification information. + 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. properties: - OrgnlId: - allOf: - - $ref: "#/components/schemas/Max35Text" - - description: > - OriginalIdentification - - Unique identification, as assigned by a sending party, to - unambiguously identify the party and account identification - information group within the original message. - Vrfctn: - allOf: - - $ref: "#/components/schemas/IdentificationVerificationIndicator" - - description: > - Verification - - Identifies whether the party and/or account information received - is correct. Boolean value. - Rsn: - allOf: - - $ref: "#/components/schemas/VerificationReason1Choice" - - description: > - Reason - - Specifies the reason why the verified identification information - is incorrect. - OrgnlPtyAndAcctId: + GrpHdr: allOf: - - $ref: "#/components/schemas/IdentificationInformation4" - - description: > - OriginalPartyAndAccountIdentification - - Provides party and/or account identification information as - given in the original message. - UpdtdPtyAndAcctId: + - $ref: '#/components/schemas/GroupHeader129b' + - description: | + GroupHeader. + Set of characteristics shared by all individual transactions included in the message. + CdtTrfTxInf: allOf: - - $ref: "#/components/schemas/IdentificationInformation4" + - $ref: '#/components/schemas/CreditTransferTransaction68' - description: | - UpdatedPartyAndAccountIdentification - Provides party and/or account identification information. + CreditTransferTransactionInformation. + Set of elements providing information specific to the individual credit transfer(s). required: - - OrgnlId - - Vrfctn + - GrpHdr + - CdtTrfTxInf example: - OrgnlId: 1.2345678901234568e+33 - Vrfctn: true - OrgnlPtyAndAcctId: - Nm: John Doe - PstlAdr: - AdrTp: ADDR - Dept: Dept - SubDept: SubDept - StrtNm: 1234 Elm St - BldgNb: 1234 - PstCd: 12345 - TwnNm: Anytown - CtrySubDvsn: CA - Ctry: US - Id: - OrgId: - AnyBIC: ABCDUS33 - Othr: - Id: 123456789 - Issr: ABA - UpdtdPtyAndAcctId: - Nm: John Doe - PstlAdr: - AdrTp: ADDR - Dept: Dept - SubDept: SubDept - StrtNm: 1234 Elm St - BldgNb: 1234 - PstCd: 12345 - TwnNm: Anytown - CtrySubDvsn: CA - Ctry: US - Id: - OrgId: - AnyBIC: ABCDUS33 - Othr: - Id: 123456789 - Issr: ABA - hexBinary: - title: hexBinary - type: string - example: 4660 - pattern: ^[A-Za-z0-9-_]+[=]{0,2}$ + GrpHdr: + MsgId: 20191113001 + CreDtTm: '2019-11-13T10:00:00' + NbOfTxs: 1 + CtrlSum: 1000 + InitgPty: + Nm: Initiating Party Name + Id: + OrgId: + Othr: + Id: 123456789 + SchmeNm: + Cd: BBA + FwdgAgt: + FinInstnId: + BICFI: BBBBBBBB + DbtrAgt: + FinInstnId: + BICFI: AAAAAAAA + CdtrAgt: + FinInstnId: + BICFI: CCCCCCCC + CdtTrfTxInf: + PmtId: + InstrId: 20191113001 + EndToEndId: 20191113001 + PmtTpInf: + InstrPrty: NORM + CtgyPurp: + Cd: SUPP + InstrForCdtrAgt: + Cd: /ACC/123456789 + IntrBkSttlmAmt: + Amt: 1000 + Ccy: EUR + ChrgBr: SHAR + CdtrAgt: + FinInstnId: + BICFI: CCCCCCCC + Cdtr: + Nm: Creditor Name + CdtrAcct: + Id: + IBAN: BE71096123456769 + RmtInf: + Ustrd: Payment for invoice 12345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml index 0b9f809b..cc0ad8ee 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml @@ -5,10 +5,7 @@ description: | DEBT: BorneByDebtor All transaction charges are to be borne by the debtor. CRED: BorneByCreditor All transaction charges are to be borne by the creditor. - SHAR: Shared In a credit transfer context, means that transaction charges on - the sender side are to be borne by the debtor, transaction charges on the receiver side are to - be borne by the creditor. In a direct debit context, means that transaction charges on the sender side - are to be borne by the creditor, transaction charges on the receiver + SHAR: This charge code is not supported, however it is used in testing when the charge bearer is unknown. type: string enum: - DEBT diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml index 262f2b5b..df29f0c0 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml @@ -147,6 +147,7 @@ required: - DbtrAgt - CdtrAgt - Cdtr + - Purp example: PmtId: InstrId: INSTRID diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67b.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67b.yaml new file mode 100644 index 00000000..219c5a10 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67b.yaml @@ -0,0 +1,223 @@ +title: CreditTransferTransaction67 +description: > + Provides further details specific to the individual transaction(s) included in + the message. +type: object +properties: + PmtId: + allOf: + - $ref: ./PaymentIdentification13.yaml + - description: > + PaymentIdentification + + Set of elements used to reference a payment instruction. + PmtTpInf: + allOf: + - $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 + - description: > + InterbankSettlementAmount + + Amount of money moved between the instructing agent and the instructed agent. + 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. + XchgRate: + allOf: + - $ref: ./BaseOneRate.yaml + - description: > + ExchangeRate + + Factor used to convert an amount from one currency into another. This reflects the price at + which one currency was bought with another currency. + ChrgBr: + $ref: ./ChargeBearerType1Code.yaml + ChrgsInf: + allOf: + - $ref: ./Charges16.yaml + - description: > + ChargesInformation + + Provides information on the charges to be paid by the charge bearer(s) related to the + payment transaction. + Dbtr: + allOf: + - $ref: ./PartyIdentification272.yaml + - description: > + Debtor + + Party that owes an amount of money to the (ultimate) creditor. + DbtrAcct: + allOf: + - $ref: ./CashAccount40.yaml + - description: > + DebtorAccount + + Unambiguous identification of the account of the debtor to which a debit entry will be made + as a result of the transaction. + DbtrAgt: + allOf: + - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml + - description: > + DebtorAgent + + Financial institution servicing an account for the debtor. + CdtrAgt: + allOf: + - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml + - description: > + CreditorAgent + + Financial institution servicing an account for the creditor. + Cdtr: + allOf: + - $ref: ./PartyIdentification272.yaml + - description: > + Creditor + + Party to which an amount of money is due. + CdtrAcct: + allOf: + - $ref: ./CashAccount40.yaml + - description: > + CreditorAccount + + Unambiguous identification of the account of the creditor to which a credit entry will be + posted as a result of the payment transaction. + InstrForCdtrAgt: + allOf: + - $ref: ./InstructionForCreditorAgent3.yaml + - description: > + InstructionForCreditorAgent + + Set of elements used to provide information on the remittance advice. + InstrForNxtAgt: + allOf: + - $ref: ./InstructionForNextAgent1.yaml + - description: > + InstructionForNextAgent + + Set of elements used to provide information on the remittance advice. + Purp: + allOf: + - $ref: ./Purpose2Choice.yaml + - description: > + Purpose + + Underlying reason for the payment transaction. + RgltryRptg: + allOf: + - $ref: ./RegulatoryReporting3.yaml + - description: > + RegulatoryReporting + + Information needed due to regulatory and statutory requirements. + Tax: + allOf: + - $ref: ./TaxData1.yaml + - description: > + Tax + + Provides details on the tax. + VrfctnOfTerms: + $ref: ./CryptographicLockChoice.yaml +required: + - PmtId + - IntrBkSttlmAmt + - ChrgBr + - Dbtr + - DbtrAgt + - CdtrAgt + - Cdtr + - VrfctnOfTerms +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 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml index 60036999..1c932589 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml @@ -100,6 +100,8 @@ required: - IntrBkSttlmAmt - Dbtr - Cdtr + - UndrlygCstmrCdtTrf + - VrfctnOfTerms example: PmtId: InstrId: INSTRID diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68_FX_Quotes.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68_FX_Quotes.yaml index c8f91e33..89145149 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68_FX_Quotes.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68_FX_Quotes.yaml @@ -98,8 +98,10 @@ properties: required: - PmtId - IntrBkSttlmAmt + - UndrlygCstmrCdtTrf - Dbtr - Cdtr + - InstrForCdtrAgt example: PmtId: InstrId: INSTRID diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68_FX_Quotesb.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68_FX_Quotesb.yaml new file mode 100644 index 00000000..ffec6741 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68_FX_Quotesb.yaml @@ -0,0 +1,139 @@ +title: CreditTransferTransaction68_FX_Quotes +description: > + Provides further details specific to the individual transaction(s) included in + the message. +type: object +properties: + PmtId: + allOf: + - $ref: ./PaymentIdentification13.yaml + - description: > + PaymentIdentification + + Set of elements used to reference a payment instruction. + PmtTpInf: + allOf: + - $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 + - description: > + InterbankSettlementAmount + + Amount of money moved between the instructing agent and the instructed agent. + Dbtr: + allOf: + - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml + - description: > + Debtor + + Party that owes an amount of money to the (ultimate) creditor. + DbtrAcct: + allOf: + - $ref: ./CashAccount40.yaml + - description: > + DebtorAccount + + Account used to process a payment. + DbtrAgt: + allOf: + - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml + - description: > + DebtorAgent + + Financial institution servicing an account for the debtor. + CdtrAgt: + allOf: + - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml + - description: > + CreditorAgent + + Financial institution servicing an account for the creditor. + Cdtr: + allOf: + - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml + - description: > + Creditor + + Party to which an amount of money is due. + CdtrAcct: + allOf: + - $ref: ./CashAccount40.yaml + - description: > + CreditorAccount + + Account to which a credit entry is made. + InstrForCdtrAgt: + allOf: + - $ref: ./InstructionForCreditorAgent3_FX_Quotes.yaml + - description: > + InstructionForCreditorAgent + + Set of elements used to provide information on the remittance advice. + Purp: + allOf: + - $ref: ./Purpose2Choice.yaml + - description: > + Purpose + + Underlying reason for the payment transaction. + VrfctnOfTerms: + allOf: + - $ref: ./CryptographicLockChoice.yaml + - description: > + VerificationOfTerms + + Set of elements used to provide information on the underlying terms of the transaction. +required: + - PmtId + - IntrBkSttlmAmt + - UndrlygCstmrCdtTrf + - Dbtr + - Cdtr + - VrfctnOfTerms + - InstrForCdtrAgt +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 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 b3992756..01c18653 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml @@ -3,14 +3,14 @@ type: object properties: GrpHdr: allOf: - - $ref: ./GroupHeader129.yaml + - $ref: ./GroupHeader129b.yaml - description: > Group Header Set of characteristics shared by all individual transactions included in the message. CdtTrfTxInf: allOf: - - $ref: ./CreditTransferTransaction67.yaml + - $ref: ./CreditTransferTransaction67b.yaml - description: > Credit Transfer Transaction Information @@ -25,7 +25,7 @@ example: PmtInstrXpryDtTm: '2020-01-01T00:00:00Z' NbOfTxs: 1 SttlmInf: - SttlmMtd: INDA + SttlmMtd: CLRG SttlmAcct: Id: IBAN: 123 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml index fe9193db..25c45a04 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml @@ -47,7 +47,8 @@ properties: Unique identification of an agent, as assigned by an institution, using an identification scheme. -required: [] +required: + - Othr example: BICFI: J5BMVH7D ClrSysMmbId: diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml index 1e188b93..15302b57 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml @@ -47,7 +47,8 @@ properties: Unique identification of an agent, as assigned by an institution, using an identification scheme. -required: [] +required: + - Othr example: BICFI: J5BMVH7D ClrSysMmbId: diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml index c9a97ffd..fbf403e3 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml @@ -7,7 +7,7 @@ description: > properties: GrpHdr: allOf: - - $ref: ./GroupHeader113.yaml + - $ref: ./GroupHeader129b.yaml - description: > GroupHeader @@ -29,7 +29,7 @@ example: Ccy: EUR Value: 100.0 SttlmInf: - SttlmMtd: INDA + SttlmMtd: CLRG SttlmAcct: Id: IBAN: BE71096123456769 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 e3a761f7..47ed546c 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml @@ -7,14 +7,14 @@ description: > properties: GrpHdr: allOf: - - $ref: ./GroupHeader113.yaml + - $ref: ./GroupHeader129b.yaml - description: > GroupHeader Set of characteristics shared by all individual transactions included in the message. CdtTrfTxInf: allOf: - - $ref: ./CreditTransferTransaction68_FX_Quotes.yaml + - $ref: ./CreditTransferTransaction68_FX_Quotesb.yaml - description: > CreditTransferTransaction68_FX_Quotes 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 f9291b99..0800ffe8 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml @@ -5,7 +5,7 @@ description: > properties: GrpHdr: allOf: - - $ref: ./GroupHeader129.yaml + - $ref: ./GroupHeader129b.yaml - description: > GroupHeader. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml index f8fa10eb..69da3027 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml @@ -10,7 +10,7 @@ properties: Information related to the identification assignment. Rpt: allOf: - - $ref: ./VerificationReport4.yaml + - $ref: ./VerificationReport4b.yaml - description: > Report diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml index 6f42477b..ca78a5cf 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml @@ -47,7 +47,7 @@ example: Ccy: EUR Value: 100.0 SttlmInf: - SttlmMtd: INDA + SttlmMtd: CLRG SttlmAcct: Id: IBAN: BE71096123456769 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113b.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113b.yaml new file mode 100644 index 00000000..ca78a5cf --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113b.yaml @@ -0,0 +1,64 @@ +title: GroupHeader113 +description: > + Set of characteristics shared by all individual transactions included in the + message. +type: object +properties: + MsgId: + allOf: + - $ref: ./Max35Text.yaml + - description: > + Message Identification + CreDtTm: + allOf: + - $ref: ./ISODateTime.yaml + - description: > + Creation Date and Time + NbOfTxs: + allOf: + - $ref: ./Max15NumericText.yaml + - description: > + Number of Transactions + TtlIntrBkSttlmAmt: + allOf: + - $ref: ./ActiveCurrencyAndAmount.yaml + - description: > + Total Interbank Settlement Amount + SttlmInf: + allOf: + - $ref: ./SettlementInstruction15.yaml + - description: > + Settlement Information + PmtTpInf: + allOf: + - $ref: ./PaymentTypeInformation28.yaml + - description: > + Payment Type Information +required: + - MsgId + - CreDtTm + - NbOfTxs + - SttlmInf +example: + MsgId: 12345 + CreDtTm: '2020-01-01T00:00:00Z' + NbOfTxs: 1 + TtlIntrBkSttlmAmt: + Ccy: EUR + Value: 100.0 + SttlmInf: + SttlmMtd: CLRG + SttlmAcct: + Id: + IBAN: BE71096123456769 + Ccy: EUR + SttlmAcctOwnr: + Nm: Name + SttlmAcctSvcr: + Nm: Name + SttlmAgt: + FinInstnId: + BICFI: BIC + PmtTpInf: + InstrPrty: NORM + CtgyPurp: CASH diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml index 75d70be9..7b46820e 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml @@ -40,7 +40,7 @@ example: PmtInstrXpryDtTm: '2020-01-01T00:00:00Z' NbOfTxs: 1 SttlmInf: - SttlmMtd: INDA + SttlmMtd: CLRG SttlmAcct: Id: IBAN: 123 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129b.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129b.yaml new file mode 100644 index 00000000..ab28e156 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129b.yaml @@ -0,0 +1,51 @@ +title: GroupHeader129 +description: > + Group Header Set of characteristics shared by all individual transactions included in the + message. +type: object +properties: + MsgId: + allOf: + - $ref: ./Max35Text.yaml + - description: > + Message Identification + CreDtTm: + allOf: + - $ref: ./ISODateTime.yaml + - description: > + Creation Date and Time + PmtInstrXpryDtTm: + allOf: + - $ref: ./ISODateTime.yaml + - description: > + Payment Instruction Expiry Date and Time + NbOfTxs: + allOf: + - $ref: ./Max15NumericText.yaml + - description: > + Number of Transactions + SttlmInf: + allOf: + - $ref: ./SettlementInstruction15.yaml + - description: > + Settlement Information +required: + - MsgId + - CreDtTm + - NbOfTxs + - SttlmInf + - PmtInstrXpryDtTm +example: + MsgId: 12345 + CreDtTm: '2020-01-01T00:00:00Z' + PmtInstrXpryDtTm: '2020-01-01T00:00:00Z' + NbOfTxs: 1 + SttlmInf: + SttlmMtd: CLRG + SttlmAcct: + Id: + IBAN: 123 + SttlmAcctOwnr: + Nm: John Doe + SttlmAcctSvcr: + BICFI: 123 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml index cdb24f19..0b28c2f1 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml @@ -11,7 +11,7 @@ properties: Set of characteristics shared by all individual transactions included in the message. TxInfAndSts: allOf: - - $ref: ./PaymentTransaction163.yaml + - $ref: ./PaymentTransaction163b.yaml - description: > Information concerning the original transactions, to which the status report message refers. SplmtryData: @@ -21,13 +21,14 @@ properties: Additional information that cannot be captured in the structured elements and/or any other specific block. required: - GrpHdr + - TxInfAndSts example: GrpHdr: MsgId: 12345 CreDtTm: '2020-01-01T00:00:00Z' NbOfTxs: 1 SttlmInf: - SttlmMtd: INDA + SttlmMtd: CLRG SttlmDt: '2020-01-01' InstgAgt: FinInstnId: 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 0466541e..03311f49 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml @@ -20,6 +20,7 @@ properties: Additional information that cannot be captured in the structured elements and/or any other specific block. required: - GrpHdr + - TxInfAndSts example: GrpHdr: MsgId: 12345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15patch.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15patch.yaml new file mode 100644 index 00000000..4ac18ca0 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15patch.yaml @@ -0,0 +1,44 @@ +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: + - $ref: ./GroupHeader120.yaml + - description: > + Set of characteristics shared by all individual transactions included in the message. + TxInfAndSts: + allOf: + - $ref: ./PaymentTransaction163patch.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 + - TxInfAndSts +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 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml index ed590359..9fddfe3f 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml @@ -84,6 +84,10 @@ properties: - $ref: ./DateAndDateTime2Choice.yaml - description: > Date/time at which the instruction was processed by the specified party. +required: + - ExctnConf + - PrcgDt + - TxSts example: StsId: 12345 OrgnlInstrId: 12345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163b.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163b.yaml new file mode 100644 index 00000000..fa5bf84c --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163b.yaml @@ -0,0 +1,105 @@ +title: PaymentTransaction163 +description: > + Provides further details on the original transactions, to which the status + report message refers. +type: object +properties: + StsId: + allOf: + - $ref: ./Max35Text.yaml + - description: > + Unique identification, as assigned by the original sending party, to + unambiguously identify the status report. + OrgnlInstrId: + allOf: + - $ref: ./Max35Text.yaml + - description: | + Unique identification, as assigned by the original sending party, to + unambiguously identify the original instruction. + + (FSPIOP equivalent: transactionRequestId) + OrgnlEndToEndId: + allOf: + - $ref: ./Max35Text.yaml + - description: | + Unique identification, as assigned by the original sending party, to + unambiguously identify the original end-to-end transaction. + + (FSPIOP equivalent: transactionId) + OrgnlTxId: + allOf: + - $ref: ./Max35Text.yaml + - description: | + Unique identification, as assigned by the original sending party, to + unambiguously identify the original transaction. + + (FSPIOP equivalent: quoteId) + OrgnlUETR: + allOf: + - $ref: ./UUIDv4Identifier.yaml + - description: > + Unique end-to-end transaction reference, as assigned by the original + sending party, to unambiguously identify the original transaction. + TxSts: + allOf: + - $ref: ./ExternalPaymentTransactionStatus1Code.yaml + - description: > + Specifies the status of the transaction. + StsRsnInf: + allOf: + - $ref: ./StatusReasonInformation14b.yaml + - description: > + Information concerning the reason for the status. + AccptncDtTm: + allOf: + - $ref: ./ISODateTime.yaml + - description: > + Date and time at which the status was accepted. + AcctSvcrRef: + allOf: + - $ref: ./Max35Text.yaml + - description: > + Unique reference, as assigned by the account servicing institution, to + unambiguously identify the status report. + ClrSysRef: + allOf: + - $ref: ./Max35Text.yaml + - description: > + Reference that is assigned by the account servicing institution and + sent to the account owner to unambiguously identify the transaction. + ExctnConf: + allOf: + - $ref: ./Exact32HexBinaryText.yaml + - description: > + Unique reference, as assigned by the account servicing institution, to + unambiguously identify the confirmation. + SplmtryData: + allOf: + - $ref: ./SupplementaryData1.yaml + - 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. +required: + - StsRsnInf +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 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163patch.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163patch.yaml new file mode 100644 index 00000000..bf1d7c36 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163patch.yaml @@ -0,0 +1,106 @@ +title: PaymentTransaction163 +description: > + Provides further details on the original transactions, to which the status + report message refers. +type: object +properties: + StsId: + allOf: + - $ref: ./Max35Text.yaml + - description: > + Unique identification, as assigned by the original sending party, to + unambiguously identify the status report. + OrgnlInstrId: + allOf: + - $ref: ./Max35Text.yaml + - description: | + Unique identification, as assigned by the original sending party, to + unambiguously identify the original instruction. + + (FSPIOP equivalent: transactionRequestId) + OrgnlEndToEndId: + allOf: + - $ref: ./Max35Text.yaml + - description: | + Unique identification, as assigned by the original sending party, to + unambiguously identify the original end-to-end transaction. + + (FSPIOP equivalent: transactionId) + OrgnlTxId: + allOf: + - $ref: ./Max35Text.yaml + - description: | + Unique identification, as assigned by the original sending party, to + unambiguously identify the original transaction. + + (FSPIOP equivalent: quoteId) + OrgnlUETR: + allOf: + - $ref: ./UUIDv4Identifier.yaml + - description: > + Unique end-to-end transaction reference, as assigned by the original + sending party, to unambiguously identify the original transaction. + TxSts: + allOf: + - $ref: ./ExternalPaymentTransactionStatus1Code.yaml + - description: > + Specifies the status of the transaction. + StsRsnInf: + allOf: + - $ref: ./StatusReasonInformation14b.yaml + - description: > + Information concerning the reason for the status. + AccptncDtTm: + allOf: + - $ref: ./ISODateTime.yaml + - description: > + Date and time at which the status was accepted. + AcctSvcrRef: + allOf: + - $ref: ./Max35Text.yaml + - description: > + Unique reference, as assigned by the account servicing institution, to + unambiguously identify the status report. + ClrSysRef: + allOf: + - $ref: ./Max35Text.yaml + - description: > + Reference that is assigned by the account servicing institution and + sent to the account owner to unambiguously identify the transaction. + ExctnConf: + allOf: + - $ref: ./Exact32HexBinaryText.yaml + - description: > + Unique reference, as assigned by the account servicing institution, to + unambiguously identify the confirmation. + SplmtryData: + allOf: + - $ref: ./SupplementaryData1.yaml + - 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. +required: + - PrcgDt + - TxSts +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 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress24.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress24.yaml index d43d89f8..5f381ad7 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress24.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress24.yaml @@ -5,37 +5,69 @@ description: > postal services. properties: AdrTp: - $ref: ./AddressType3Choice.yaml + allOf: + - $ref: ./AddressType3Choice.yaml + - description: Type of address, as defined by the postal services. Dept: - $ref: ./Max70Text.yaml + allOf: + - $ref: ./Max70Text.yaml + - description: Name of a department within an organization. SubDept: - $ref: ./Max70Text.yaml + allOf: + - $ref: ./Max70Text.yaml + - description: Name of a sub-department within a department. StrtNm: - $ref: ./Max70Text.yaml + allOf: + - $ref: ./Max70Text.yaml + - description: Name of the street or thoroughfare. BldgNb: - $ref: ./Max16Text.yaml + allOf: + - $ref: ./Max16Text.yaml + - description: Number that identifies a building on the street. BldgNm: - $ref: ./Max35Text.yaml + allOf: + - $ref: ./Max35Text.yaml + - description: Name of the building, if applicable. Flr: - $ref: ./Max70Text.yaml + allOf: + - $ref: ./Max70Text.yaml + - description: Floor number or identifier within a building. PstBx: - $ref: ./Max16Text.yaml + allOf: + - $ref: ./Max16Text.yaml + - description: Post office box number. Room: - $ref: ./Max70Text.yaml + allOf: + - $ref: ./Max70Text.yaml + - description: Room number or identifier within a building. PstCd: - $ref: ./Max16Text.yaml + allOf: + - $ref: ./Max16Text.yaml + - description: Postal code or ZIP code. TwnNm: - $ref: ./Max35Text.yaml + allOf: + - $ref: ./Max35Text.yaml + - description: Name of the town or city. TwnLctnNm: - $ref: ./Max35Text.yaml + allOf: + - $ref: ./Max35Text.yaml + - description: Name of the location within a town or city. DstrctNm: - $ref: ./Max35Text.yaml + allOf: + - $ref: ./Max35Text.yaml + - description: Name of the district or region. CtrySubDvsn: - $ref: ./Max35Text.yaml + allOf: + - $ref: ./Max35Text.yaml + - description: Name of the country subdivision, such as a state or province. Ctry: - $ref: ./CountryCode.yaml + allOf: + - $ref: ./CountryCode.yaml + - description: Country code, as defined by ISO 3166-1 alpha-2. AdrLine: - $ref: ./Max70Text.yaml + allOf: + - $ref: ./Max70Text.yaml + - description: Free-form text line for the address. example: AdrTp: ADDR Dept: Dept diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress27.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress27.yaml index 0e4c1285..f79d4f53 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress27.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress27.yaml @@ -5,41 +5,77 @@ description: > postal services. properties: AdrTp: - $ref: ./AddressType3Choice.yaml + allOf: + - $ref: ./AddressType3Choice.yaml + - description: Type of address, as defined by the postal services. CareOf: - $ref: ./Max140Text.yaml + allOf: + - $ref: ./Max140Text.yaml + - description: Name of the person or entity the mail is directed to, if different from the recipient. Dept: - $ref: ./Max70Text.yaml + allOf: + - $ref: ./Max70Text.yaml + - description: Name of a department within an organization. SubDept: - $ref: ./Max70Text.yaml + allOf: + - $ref: ./Max70Text.yaml + - description: Name of a sub-department within a department. StrtNm: - $ref: ./Max140Text.yaml + allOf: + - $ref: ./Max140Text.yaml + - description: Name of the street or thoroughfare. BldgNb: - $ref: ./Max16Text.yaml + allOf: + - $ref: ./Max16Text.yaml + - description: Number that identifies a building on the street. BldgNm: - $ref: ./Max140Text.yaml + allOf: + - $ref: ./Max140Text.yaml + - description: Name of the building, if applicable. Flr: - $ref: ./Max70Text.yaml + allOf: + - $ref: ./Max70Text.yaml + - description: Floor number or identifier within a building. UnitNb: - $ref: ./Max16Text.yaml + allOf: + - $ref: ./Max16Text.yaml + - description: Unit or apartment number within a building. PstBx: - $ref: ./Max16Text.yaml + allOf: + - $ref: ./Max16Text.yaml + - description: Post office box number. Room: - $ref: ./Max70Text.yaml + allOf: + - $ref: ./Max70Text.yaml + - description: Room number or identifier within a building. PstCd: - $ref: ./Max16Text.yaml + allOf: + - $ref: ./Max16Text.yaml + - description: Postal code or ZIP code. TwnNm: - $ref: ./Max140Text.yaml + allOf: + - $ref: ./Max140Text.yaml + - description: Name of the town or city. TwnLctnNm: - $ref: ./Max140Text.yaml + allOf: + - $ref: ./Max140Text.yaml + - description: Name of the location within a town or city. DstrctNm: - $ref: ./Max140Text.yaml + allOf: + - $ref: ./Max140Text.yaml + - description: Name of the district or region. CtrySubDvsn: - $ref: ./Max35Text.yaml + allOf: + - $ref: ./Max35Text.yaml + - description: Name of the country subdivision, such as a state or province. Ctry: - $ref: ./CountryCode.yaml + allOf: + - $ref: ./CountryCode.yaml + - description: Country code, as defined by ISO 3166-1 alpha-2. AdrLine: - $ref: ./Max70Text.yaml + allOf: + - $ref: ./Max70Text.yaml + - description: Free-form text line for the address. example: AdrTp: ADDR CareOf: CareOf diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml index 324fb3ad..1a0edb41 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml @@ -1,17 +1,16 @@ title: SettlementInstruction15 description: | + Only the CLRG: Clearing option is supported. Specifies the details on how the settlement of the original transaction(s) between the instructing agent and the instructed agent was completed. type: object properties: SttlmMtd: $ref: ./SettlementMethod1Code.yaml - PmtTpInf: - $ref: ./PaymentTypeInformation28.yaml required: - SttlmMtd example: - SttlmMtd: INDA + SttlmMtd: CLRG PmtTpInf: InstrPrty: NORM SvcLvl: diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml index 4b2d541f..6ebe55d1 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml @@ -1,16 +1,8 @@ title: SettlementMethod1Code description: | Specifies the method used to settle the credit transfer instruction. - - INDA: Indirect Account - INGA: Indirect Agent - COVE: Cover - CLRG: Clearing - + Only the CLRG: Clearing option is supported. type: string enum: - - INDA - - INGA - - COVE - CLRG example: CLRG \ No newline at end of file diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14b.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14b.yaml new file mode 100644 index 00000000..171bb151 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14b.yaml @@ -0,0 +1,44 @@ +title: StatusReasonInformation14 +description: | + Unsure on description. +type: object +properties: + Orgtr: + allOf: + - $ref: ./PartyIdentification272.yaml + - description: > + Originator + + Party that issues the status. + Rsn: + allOf: + - $ref: ./StatusReason6Choice.yaml + - description: > + Reason + + Specifies the reason for the status report. + AddtlInf: + allOf: + - $ref: ./Max105Text.yaml + - description: > + AdditionalInformation + + Additional information about the status report. +required: + - Rsn +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 \ No newline at end of file diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml index cdbf7067..c93a1165 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml @@ -5,14 +5,14 @@ description: > properties: GrpHdr: allOf: - - $ref: ./GroupHeader129.yaml + - $ref: ./GroupHeader129b.yaml - description: > Group Header Set of characteristics shared by all individual transactions included in the message. CdtTrfTxInf: allOf: - - $ref: ./CreditTransferTransaction67.yaml + - $ref: ./CreditTransferTransaction67b.yaml - description: > Credit Transfer Transaction Information diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/UnderlyingCustomerCreditTransfer.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/UnderlyingCustomerCreditTransfer.yaml index f4be0824..1efe6b4b 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/UnderlyingCustomerCreditTransfer.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/UnderlyingCustomerCreditTransfer.yaml @@ -34,3 +34,4 @@ required: - Cdtr - DbtrAgt - CdtrAgt + - InstdAmt diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml index 20310106..de471373 100644 --- a/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml @@ -45,6 +45,7 @@ properties: required: - OrgnlId - Vrfctn + - UpdtdPtyAndAcctId example: OrgnlId: 1234567890123456789012345678901234 Vrfctn: true diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4b.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4b.yaml new file mode 100644 index 00000000..8ee0257e --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4b.yaml @@ -0,0 +1,87 @@ +title: VerificationReport4 +type: object +description: + VerificationReport + + Provides information about the verification of party and/or account identification information. +properties: + OrgnlId: + allOf: + - $ref: ./Max35Text.yaml + - description: > + OriginalIdentification + + Unique identification, as assigned by a sending party, to unambiguously identify the party + and account identification information group within the original message. + Vrfctn: + allOf: + - $ref: ./IdentificationVerificationIndicator.yaml + - description: > + Verification + + Identifies whether the party and/or account information received is correct. + Boolean value. + Rsn: + allOf: + - $ref: ./VerificationReason1Choice.yaml + - description: > + Reason + + Specifies the reason why the verified identification information is incorrect. + OrgnlPtyAndAcctId: + allOf: + - $ref: ./IdentificationInformation4.yaml + - description: > + OriginalPartyAndAccountIdentification + + Provides party and/or account identification information as given in the original message. + UpdtdPtyAndAcctId: + allOf: + - $ref: ./IdentificationInformation4.yaml + - description: > + UpdatedPartyAndAccountIdentification + + Provides party and/or account identification information. +required: + - OrgnlId + - Vrfctn + - Rsn +example: + OrgnlId: 1234567890123456789012345678901234 + 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 diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}.yaml index 150957c1..612dd8dd 100644 --- a/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}.yaml @@ -59,7 +59,7 @@ patch: content: application/json: schema: - $ref: ../components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml + $ref: ../components/schemas/PacsStatus_FIToFIPaymentStatusReportV15patch.yaml responses: '200': $ref: ../components/responses/200.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}.yaml index 16fa1640..2d0c4b7d 100644 --- a/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}.yaml +++ b/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}.yaml @@ -59,7 +59,7 @@ patch: content: application/json: schema: - $ref: ../components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml + $ref: ../components/schemas/PacsStatus_FIToFIPaymentStatusReportV15patch.yaml responses: '200': $ref: ../components/responses/200.yaml diff --git a/package-lock.json b/package-lock.json index b947819e..529fdb08 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16992,7 +16992,8 @@ } }, "dompurify": { - "version": "https://registry.npmjs.org/dompurify/-/dompurify-3.2.4.tgz", + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/dompurify/-/dompurify-3.2.4.tgz", "integrity": "sha512-ysFSFEDVduQpyhzAob/kkuJjf5zWkZD8/A9ywSp1byueyuCfHamrCBa14/Oc2iiB0e51B+NpxSl5gmzn+Ms/mg==", "dev": true, "requires": { @@ -21226,7 +21227,7 @@ "@redocly/openapi-core": "^1.0.0-rc.2", "classnames": "^2.3.1", "decko": "^1.2.0", - "dompurify": "^2.2.8", + "dompurify": "3.2.4", "eventemitter3": "^4.0.7", "json-pointer": "^0.6.2", "lunr": "^2.3.9", diff --git a/src/fspiop/v2_0_ISO20022/json-schemas.json b/src/fspiop/v2_0_ISO20022/json-schemas.json index 53a4ff42..43ac3180 100644 --- a/src/fspiop/v2_0_ISO20022/json-schemas.json +++ b/src/fspiop/v2_0_ISO20022/json-schemas.json @@ -1,116 +1,411 @@ { - "AccountIdentification4Choice": { - "title": "AccountIdentification4Choice", + "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." + }, + "ExtensionKey": { + "title": "ExtensionKey", + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "Extension key." + }, + "ExtensionValue": { + "title": "ExtensionValue", + "type": "string", + "minLength": 1, + "maxLength": 128, + "description": "Extension value." + }, + "Extension": { + "title": "Extension", "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "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" + ] + }, + "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" + ] + }, + "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" + ] + } + } + }, + "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 + }, + "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" + }, + "Max140Text": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "AddressType2Code": { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "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 + }, + "GenericIdentification30": { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + "AddressType3Choice": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { - "IBAN": { + "Cd": { "allOf": [ { - "title": "IBAN2007Identifier", - "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], "type": "string", - "example": "FR1420041010050500013M02606", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" + "example": "ADDR" }, { - "description": "IBAN\nInternational Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions.\n" + "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ - "IBAN" + "Cd" ] }, { "properties": { - "Othr": { + "Prtry": { "allOf": [ { - "title": "GenericAccountIdentification1", + "title": "GenericIdentification30", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "SchmeNm": { + "Issr": { "allOf": [ { - "title": "AccountSchemeName1Choice", - "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "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 - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "Issr": { + "SchmeNm": { "allOf": [ { "title": "Max35Text", @@ -121,1116 +416,572 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Id" + "Id", + "Issr" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ - "Othr" + "Prtry" ] } ], "example": { - "IBAN": "BE71096123456769" + "Cd": "ADDR" } }, - "AccountSchemeName1Choice": { - "title": "AccountSchemeName1Choice", + "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 + }, + "Max16Text": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "CountryCode": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "PostalAddress24": { + "title": "PostalAddress24", "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": "Information that locates and identifies a 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" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "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": 1111 + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, - "ActiveCurrencyAndAmount": { - "title": "ActiveCurrencyAndAmount", + "AnyBICDec2014Identifier": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "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" + }, + "ExternalOrganisationIdentification1Code": { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "OrganisationIdentificationSchemeName1Choice": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", "type": "object", - "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { - "ActiveCurrencyAndAmount": { + "Cd": { "allOf": [ { - "title": "ActiveCurrencyAndAmount_SimpleType", + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", "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 + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, - "Ccy": { + "Prtry": { "allOf": [ { - "title": "ActiveCurrencyCode", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, - "required": [ - "ActiveCurrencyAndAmount", - "Ccy" + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } ], "example": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Cd": "BIC" } }, - "ActiveCurrencyAndAmount_SimpleType": { - "title": "ActiveCurrencyAndAmount_SimpleType", - "type": "string", - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", - "example": 123.45 - }, - "ActiveCurrencyCode": { - "title": "ActiveCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - "ActiveOrHistoricCurrencyAndAmount": { - "title": "ActiveOrHistoricCurrencyAndAmount", + "GenericOrganisationIdentification1": { + "title": "GenericOrganisationIdentification1", "type": "object", - "description": "A number 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 an organisation.\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 for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, - "Ccy": { + "SchmeNm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "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", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "Id" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" } }, - "ActiveOrHistoricCurrencyAndAmount_SimpleType": { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", - "type": "string", - "example": 123.45, - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" - }, - "ActiveOrHistoricCurrencyCode": { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - "AddressType2Code": { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - "AddressType3Choice": { - "title": "AddressType3Choice", + "OrganisationIdentification29": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\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" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] + "properties": { + "AnyBIC": { + "allOf": [ + { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "AnyBIC\nBusiness identification code of the organisation.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" - } - ] + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[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": "ADDR" - } - }, - "AmountTypeEnum": { - "title": "AmountTypeEnum", - "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", - "type": "string", - "enum": [ - "SEND", - "RECEIVE" - ], - "example": "SEND" - }, - "AnyBICDec2014Identifier": { - "title": "AnyBICDec2014Identifier", - "type": "string", - "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - "BICFIDec2014Identifier": { - "title": "BICFIDec2014Identifier", - "type": "string", - "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - "BaseOneRate": { - "title": "BaseOneRate", - "type": "string", - "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", - "example": 0.7, - "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" - }, - "BranchAndFinancialInstitutionIdentification6": { - "title": "BranchAndFinancialInstitutionIdentification6", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { + }, + "Othr": { "allOf": [ { - "title": "FinancialInstitutionIdentification18", + "title": "GenericOrganisationIdentification1", "type": "object", - "description": "Information used to identify a financial institution.\n", + "description": "Information that locates and identifies an organisation.\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 for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\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": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\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": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification 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\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, - "MmbId": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -1241,270 +992,276 @@ "example": 1.234567890123457e+34 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, - "required": [ - "MmbId" + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Cd": "BIC" } }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": "BIC" }, - "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", + "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" + } + } + }, + "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" + }, + "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" + } + }, + "ExternalPersonIdentification1Code": { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "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" + } + }, + "GenericPersonIdentification1": { + "title": "GenericPersonIdentification1", + "type": "object", + "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 4, + "example": 1234 }, - "CtrySubDvsn": { + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -1512,206 +1269,80 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "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\nName of the identification scheme, in a free text form.\n" } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + ] } + }, + "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": "CCPT" } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "BrnchId": { + "Issr": { "allOf": [ { - "title": "BranchData3", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "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" + } + }, + "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", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { - "Id": { + "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", @@ -1722,414 +1353,273 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, - "LEI": { + "CityOfBirth": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated 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": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" + "description": "CityOfBirth\nCity where a person was born.\n" } ] }, - "Nm": { + "CtryOfBirth": { "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": "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": 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": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "PstlAdr": { + "SchmeNm": { "allOf": [ { - "title": "PostalAddress24", + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } - }, - "required": [ - "Cd" ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" - } - ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } - }, - "required": [ - "Prtry" ] } - ], - "example": { - "Cd": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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" + "Cd": "CCPT" } }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, + "required": [ + "Id" + ], "example": { "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" } }, { - "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "FinInstnId" - ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - "BrnchId": { + "Othr": { "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 } } } }, - "BranchAndFinancialInstitutionIdentification8": { - "title": "BranchAndFinancialInstitutionIdentification8", + "Party38Choice": { + "title": "Party38Choice", + "description": "Nature or use of the account.\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": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "allOf": [ + { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "AnyBIC\nBusiness identification code of the organisation.\n" + } + ] }, - { - "description": "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": [ + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[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": "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" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { + }, "Prtry": { "allOf": [ { @@ -2141,628 +1631,233 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, - "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": [ + "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": {} + } }, { - "description": "Code\nType of address expressed as a code.\n" + "properties": { + "Prtry": {} + } } - ] + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" - } - ] + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum 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": "BIC" + }, + "Issr": "BIC" } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "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" }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "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" + "Issr": "BIC" } - ] + } }, - "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": "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 person.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "anyOf": [ + "PrvcOfBirth": { + "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": "ProvinceOfBirth\nProvince where a person was born.\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 + "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": "Issuer\nEntity that assigns the identification.\n" + "CtryOfBirth": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "CountryOfBirth\nCountry where a person was born.\n" + } + ] } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } }, - "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": "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": "PostalAddress27", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "Othr": { + "allOf": [ + { + "title": "GenericPersonIdentification1", "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": "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" } - }, - "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", @@ -2773,274 +1868,215 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "CCPT" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum 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": "DRLC" + }, + "Issr": "BIC" } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\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": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] - } - }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" + } + }, + { + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } - } - }, - { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + ] } + }, + "required": [ + "PrvtId" ] } - }, - "required": [ - "FinInstnId" ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "OrgId": { + "AnyBIC": "BIC" }, - "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" + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" } } } }, - "BranchData3": { - "title": "BranchData3", + "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" + }, + "PhoneNumber": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "Max2048Text": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "Max4Text": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Max128Text": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + }, + "OtherContact1": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", "type": "object", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { - "Id": { + "ChanlTp": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" + } + ] + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "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" + }, + "Contact4": { + "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" } ] }, @@ -3055,296 +2091,65 @@ "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": { + "PhneNb": { "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": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] - } - }, - "example": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - }, - "BranchData5": { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "type": "object", - "properties": { - "Id": { + }, + "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", @@ -3355,24 +2160,141 @@ "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" + } + ] + }, + "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" + } + }, + "PartyIdentification135": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { "Nm": { "allOf": [ { @@ -3384,14 +2306,14 @@ "example": 12345 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { - "title": "PostalAddress27", + "title": "PostalAddress24", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -3506,14 +2428,6 @@ "Cd": "ADDR" } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", @@ -3531,12 +2445,12 @@ "example": 1.2345678901234567e+99 }, "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", @@ -3547,12 +2461,12 @@ "example": 1234567890123456 }, "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", @@ -3562,14 +2476,6 @@ "maxLength": 70, "example": 1.2345678901234567e+99 }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", @@ -3595,28 +2501,28 @@ "example": 1234567890123456 }, "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", @@ -3644,14 +2550,12 @@ }, "example": { "AdrTp": "ADDR", - "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", - "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", @@ -3667,560 +2571,755 @@ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] - } - }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } - } - }, - "CashAccount40": { - "title": "CashAccount40", - "type": "object", - "description": "Provides the details to identify an account.\n", - "properties": { + }, "Id": { "allOf": [ { - "title": "AccountIdentification4Choice", + "title": "Party38Choice", + "description": "Nature or use of the account.\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": "OrganisationIdentification29", + "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": "GenericOrganisationIdentification1", "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": "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "anyOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "properties": { + "Cd": {} + } }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "properties": { + "Prtry": {} + } } - ] + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" } - }, - "required": [ - "Prtry" ] } + }, + "required": [ + "Id" ], "example": { - "Cd": 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" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ - "Othr" + "OrgId" ] - } - ], - "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": { + "PrvtId": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "BirthDate\nDate on which a person was born.\n" + } + ] + }, + "PrvcOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ProvinceOfBirth\nProvince where a person was born.\n" + } + ] + }, + "CityOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "CityOfBirth\nCity where a person was born.\n" + } + ] + }, + "CtryOfBirth": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "CountryOfBirth\nCountry where a person was born.\n" + } + ] + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + { + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericPersonIdentification1", + "type": "object", + "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + } + ] + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } }, { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + "description": "PrivateIdentification\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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + "description": "Identification\nUnique and unambiguous way to identify an organisation.\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": "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" } ] }, - "Prxy": { + "CtctDtls": { "allOf": [ { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", + "title": "Contact4", + "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", + "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", - "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" - } - ] + "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\nProxy account type, in a proprietary 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": "EMAIL" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "Type\nType of the proxy identification.\n" + "description": "Other\nContact details in another form.\n" } ] }, - "Id": { + "PrefrdMtd": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" }, { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, - "required": [ - "Id" - ], "example": { - "Tp": { - "Cd": "IBAN" - }, - "Id": 123 + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" } }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "Id": { - "IBAN": "BE71096123456769" + "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": { - "Cd": "CACC" + "Id": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Prtry": "DfspId" + } + } + } }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" } } }, - "CashAccountType2Choice": { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", + "BICFIDec2014Identifier": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ExternalClearingSystemIdentification1Code": { + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "ClearingSystemIdentification2Choice": { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", "anyOf": [ { @@ -4228,15 +3327,15 @@ "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": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 5, + "example": 12345 }, { - "description": "Code\nAccount type, in a coded form.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } @@ -4258,7 +3357,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } @@ -4269,27 +3368,128 @@ } ], "example": { - "Cd": "CACC" + "Cd": "CHIPS" } }, - "CategoryPurpose1Choice": { - "title": "CategoryPurpose1Choice", - "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "ClearingSystemMemberIdentification2": { + "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 + } + }, + "ExternalFinancialInstitutionIdentification1Code": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification 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": [ { - "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", - "maxLength": 4, - "minLength": 1, + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", "type": "string", + "minLength": 1, + "maxLength": 4, "example": 1234 }, { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } @@ -4311,7 +3511,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nCategory purpose, in a proprietary form.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -4322,72 +3522,61 @@ } ], "example": { - "Cd": "CASH" + "Cd": "BIC" } }, - "ChargeBearerType1Code": { - "title": "ChargeBearerType1Code", - "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", - "type": "string", - "enum": [ - "DEBT", - "CRED", - "SHAR" - ], - "example": "DEBT" - }, - "ChargeType3Choice": { - "title": "ChargeType3Choice", - "description": "ChargeType3Choice\nSpecifies the type of charge.\n", + "GenericFinancialIdentification1": { + "title": "GenericFinancialIdentification1", "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": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "SchmeNm": { + "allOf": [ + { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ { - "title": "GenericIdentification3", - "type": "object", - "description": "Generic scheme identification for a party.\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 + "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\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, - "Issr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -4398,681 +3587,262 @@ "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, - "Issr": "BIC" - } - }, - { - "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n" + "Prtry" + ] } - ] - } - }, - "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": { - "Cd": "CASH" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, - "Charges16": { - "title": "Charges16", - "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n", + "FinancialInstitutionIdentification18": { + "title": "FinancialInstitutionIdentification18", "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "Amt": { + "BICFI": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "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": "A number of monetary 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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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" + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "Agt": { + "LEI": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": "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": { - "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": { + "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] - } - }, - "required": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 - } - }, - { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" - }, - { - "description": "LEI\nLegal entity identifier of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] - }, - "Othr": { - "allOf": [ - { - "title": "GenericFinancialIdentification1", - "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", - "properties": { - "Id": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -5083,72 +3853,11 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "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", @@ -5159,499 +3868,234 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Id" + "Id", + "Issr" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 - }, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 - } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "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" - } - ] + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "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", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "Tp": { + "Othr": { "allOf": [ { - "title": "ChargeType3Choice", - "description": "ChargeType3Choice\nSpecifies the type of charge.\n", + "title": "GenericFinancialIdentification1", "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": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "SchmeNm": { + "allOf": [ + { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ { - "title": "GenericIdentification3", - "type": "object", - "description": "Generic scheme identification for a party.\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 + "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\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, - "Issr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -5662,195 +4106,95 @@ "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, - "Issr": "BIC" - } - }, - { - "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\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": [ - "Prtry" ] } + }, + "required": [ + "Id" ], "example": { - "Cd": "CASH" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "Type\nDefines the type of charges.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Amt", - "Agt" - ], + "required": [], "example": { - "Amt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - }, - "Agt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" - } + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "Tp": { - "Cd": "SHAR" - } - } - }, - "ClearingChannel2Code": { - "title": "ClearingChannel2Code", - "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", - "type": "string", - "enum": [ - "RTGS", - "RTNS", - "MPNS", - "BOOK" - ], - "example": "RTGS" - }, - "ClearingSystemIdentification2Choice": { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "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" - ] + "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" - } - ] - } + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 }, - "required": [ - "Prtry" - ] + "Issr": 123 } - ], - "example": { - "Cd": "CHIPS" } }, - "ClearingSystemMemberIdentification2": { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "BranchData3": { + "title": "BranchData3", "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "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": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -5861,42 +4205,21 @@ "example": 1.234567890123457e+34 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] - } - }, - "required": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" }, - "MmbId": 123456789 - } - }, - "Contact13": { - "title": "Contact13", - "description": "Specifies the details of the contact person.\n", - "type": "object", - "properties": { - "NmPrfx": { + "LEI": { "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": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a 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": "DOCT" + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" + "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, @@ -5911,2143 +4234,1722 @@ "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": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, - "Othr": { + "PstlAdr": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "PostalAddress24", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "ChanlTp": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "Id": { - "allOf": [ - { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 128, - "example": 12345 - }, - { - "description": "Identifier\nCommunication value such as phone number or email address.\n" - } - ] - } - }, - "required": [ - "ChanlTp" - ], - "example": { - "ChanlTp": "PHON", - "Id": 1234567890 - } - }, - { - "description": "OtherContact\nContact details in another form.\n" - } - ] - }, - "PrefrdMtd": { - "allOf": [ - { - "title": "PreferredContactMethod2Code", - "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", - "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "MAIL" - }, - { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" - } - ] - } - }, - "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "URLAdr": "http://www.example.com", - "EmailAdr": "example@example.com" - } - }, - "Contact4": { - "title": "Contact4", - "description": "Specifies the details of the contact person.\n", - "type": "object", - "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" - } - ] + "Dept": { + "title": "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" - } - ] + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } }, - "required": [ - "ChanlTp" - ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "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": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } } }, - "CountryCode": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "CreditTransferTransaction67": { - "title": "CreditTransferTransaction67", - "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "BranchAndFinancialInstitutionIdentification6": { + "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "PmtId": { + "FinInstnId": { "allOf": [ { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", + "title": "FinancialInstitutionIdentification18", "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "InstrId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "EndToEndId": { + "BICFI": { "allOf": [ { - "title": "ULIDIdentifier", + "title": "BICFIDec2014Identifier", "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" + "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": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + "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" } ] }, - "TxId": { + "ClrSysMmbId": { "allOf": [ { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" + "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": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "UETR": { + "LEI": { "allOf": [ { - "title": "UUIDv4Identifier", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a 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": "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}$" + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, - "ClrSysRef": { + "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": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\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": "PostalAddress24", "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" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ], + }, "example": { - "Cd": "SEPA" + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "LclInstrm": { + "Othr": { "allOf": [ { - "title": "LocalInstrument2Choice", + "title": "GenericFinancialIdentification1", "type": "object", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "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" - } - ] + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "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": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\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" ] } + }, + "required": [ + "Id" ], "example": { - "Cd": "CH03" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "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": "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 }, - "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" + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" }, - "CtgyPurp": { - "Cd": "CASH" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, - "UndrlygCstmrCdtTrf": { + "BrnchId": { "allOf": [ { - "title": "UnderlyingCustomerCreditTransfer", + "title": "BranchData3", "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { - "InstdAmt": { + "Id": { "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "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": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "Dbtr": { + "LEI": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\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": "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": { - "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" + } }, - "Id": { - "allOf": [ - { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\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" + } + } + } + }, + "Party40Choice": { + "title": "Party40Choice", + "description": "Identification of a person, an organisation or a financial institution.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Pty": { + "allOf": [ + { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", + "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { - "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": { - "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": { + "OrgId": { "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" - } - ] - }, - "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" - } - } - }, - "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 + "required": [ + "OrgId" + ] }, { - "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" - ] - }, + "PrvtId": { + "allOf": [ { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", "properties": { - "Prtry": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "GenericIdentification30", + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", "type": "object", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { + "BirthDt": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "format": "date", + "example": "2013-03-07" }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "BirthDate\nDate on which a person was born.\n" } ] }, - "Issr": { + "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", @@ -8058,11 +5960,11 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, - "SchmeNm": { + "CityOfBirth": { "allOf": [ { "title": "Max35Text", @@ -8073,77 +5975,243 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "CityOfBirth\nCity where a person was born.\n" + } + ] + }, + "CtryOfBirth": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ - "Id", - "Issr" + "BirthDt", + "CityOfBirth", + "CtryOfBirth" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericPersonIdentification1", + "type": "object", + "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Prtry" - ] + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + }, + { + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } + ] + } + }, + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + { + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" + } + ] + }, + "CtryOfRes": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" + } + ] + }, + "CtctDtls": { + "allOf": [ + { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "allOf": [ + { + "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" ], - "example": { - "Cd": "ADDR" - } - }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 + "example": "DOCT" }, - "BldgNm": { + { + "description": "NamePrefix\nName prefix to be used before the name of the person.\n" + } + ] + }, + "Nm": { + "allOf": [ + { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", @@ -8151,71 +6219,98 @@ "maxLength": 140, "example": 12345 }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PhneNb": { + "allOf": [ + { + "title": "PhoneNumber", "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + { + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + } + ] + }, + "MobNb": { + "allOf": [ + { + "title": "PhoneNumber", "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", + { + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + } + ] + }, + "FaxNb": { + "allOf": [ + { + "title": "PhoneNumber", "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + { + "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + } + ] + }, + "EmailAdr": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 2048, + "example": 2048 }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + { + "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" + } + ] + }, + "EmailPurp": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + { + "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + } + ] + }, + "JobTitl": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "CtrySubDvsn": { + { + "description": "JobTitle\nTitle of the function.\n" + } + ] + }, + "Rspnsblty": { + "allOf": [ + { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -8223,259 +6318,388 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { + { + "description": "Responsibility\nRole of a person in an organisation.\n" + } + ] + }, + "Dept": { + "allOf": [ + { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 + }, + { + "description": "Department\nIdentification of a division of a large organisation or building.\n" } - }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } + ] }, - { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "Othr": { + "allOf": [ + { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "allOf": [ + { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + }, + { + "description": "Identifier\nCommunication value such as phone number or email address.\n" + } + ] + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + { + "description": "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" + } }, - "Id": { - "allOf": [ - { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", - "type": "object", - "anyOf": [ + { + "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + }, + "Id": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Prtry": "DfspId" + } + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + { + "description": "Party\nIdentification of a person or an organisation.\n" + } + ] + } + }, + "required": [ + "Pty" + ] + }, + { + "properties": { + "Agt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "description": "Information used to identify a financial institution.\n", + "properties": { + "BICFI": { + "allOf": [ + { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, { + "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + } + ] + }, + "ClrSysMmbId": { + "allOf": [ + { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", "properties": { - "OrgId": { + "ClrSysId": { "allOf": [ { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\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" + "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" ] }, - "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" - } - ] + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "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\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" + ] } + }, + "required": [ + "Prtry" ] } - }, + ], "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } + "Cd": "CHIPS" } }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + } + ] + }, + "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": [ - "OrgId" - ] + "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": { - "PrvtId": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "PersonIdentification18", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", "properties": { - "DtAndPlcOfBirth": { + "Cd": { "allOf": [ { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\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": { - "BirthDt": { + "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": "BirthDate\nDate on which a person was born.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "PrvcOfBirth": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -8486,11 +6710,11 @@ "example": 1.234567890123457e+34 }, { - "description": "ProvinceOfBirth\nProvince where a person was born.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "CityOfBirth": { + "SchmeNm": { "allOf": [ { "title": "Max35Text", @@ -8501,327 +6725,109 @@ "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" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" + "Id", + "Issr" ], "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } - } - }, - { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + "required": [ + "Prtry" + ] } - ] - } - }, - "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", - "example": "DOCT" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" - } - ] - }, - "PhneNb": { - "allOf": [ - { - "title": "PhoneNumber", + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" - } - ] - }, - "MobNb": { - "allOf": [ - { - "title": "PhoneNumber", + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 }, - { - "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" - } - ] - }, - "FaxNb": { - "allOf": [ - { - "title": "PhoneNumber", + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - { - "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" - } - ] - }, - "URLAdr": { - "allOf": [ - { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 2048, - "example": 2048 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" - } - ] - }, - "EmailAdr": { - "allOf": [ - { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, - "maxLength": 256, - "example": 256 + "maxLength": 16, + "example": 1234567890123456 }, - { - "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" - } - ] - }, - "EmailPurp": { - "allOf": [ - { + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -8829,14 +6835,7 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" - } - ] - }, - "JobTitl": { - "allOf": [ - { + "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -8844,14 +6843,7 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "JobTitle\nTitle of the function.\n" - } - ] - }, - "Rspnsblty": { - "allOf": [ - { + "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -8859,224 +6851,335 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Responsibility\nRole of a person in an organisation.\n" - } - ] - }, - "Dept": { - "allOf": [ - { + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 - }, - { - "description": "Department\nIdentification of a division of a large organisation or building.\n" } - ] + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } }, - "Othr": { - "allOf": [ - { - "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": "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 }, - "Id": { - "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": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 128, - "example": 12345 + "properties": { + "Cd": { + "allOf": [ + { + "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": "Identifier\nCommunication value such as phone number or email address.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" } - }, - "required": [ - "ChanlTp" - ], - "example": { - "ChanlTp": "PHON", - "Id": 1234567890 - } + ] }, - { - "description": "OtherContact\nContact details in another 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" + } + ] } - ] - }, - "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" + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" - } - ] + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an agent, 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", - "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": [], + "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 } } }, - "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, as assigned under an internationally recognised or proprietary identification scheme.\n" } - } + ] }, - { - "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" - } - ] + "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 }, - "ClrSysMmbId": { - "allOf": [ - { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\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", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "anyOf": [ + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 5, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nClearing system identification code, as published in an external list.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "SchmeNm": { "allOf": [ { "title": "Max35Text", @@ -9087,401 +7190,403 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Prtry" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - ], - "example": { - "Cd": "CHIPS" - } - }, - { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" - } - ] - }, - "MmbId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "MmbId" ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Cd": "ADDR" } }, - { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "LEI\nLegal entity identifier of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } }, - "PstlAdr": { - "allOf": [ - { - "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": "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" + ] + } + } + } + } + }, + "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": { + "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", + { + "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": "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": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\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": "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", @@ -9492,104 +7597,84 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Prtry" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - ], - "example": { - "Cd": "BIC" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum 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 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": [ - { + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -9597,103 +7682,321 @@ "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", + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "LEI\nLegal entity 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", + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 16, + "example": 1234567890123456 }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\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 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } }, - "PstlAdr": { - "allOf": [ + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "anyOf": [ { - "title": "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": [ + "OrgId": { + "allOf": [ { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", "properties": { - "Cd": { + "AnyBIC": { "allOf": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], + "title": "AnyBICDec2014Identifier", "type": "string", - "example": "ADDR" + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "AnyBIC\nBusiness identification code of the organisation.\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericOrganisationIdentification1", + "type": "object", + "description": "Information that locates and identifies an organisation.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Cd" - ] + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } }, { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + } + ] + } + }, + "required": [ + "OrgId" + ] + }, + { + "properties": { + "PrvtId": { + "allOf": [ + { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", "properties": { - "Prtry": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "GenericIdentification30", + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", "type": "object", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { + "BirthDt": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "format": "date", + "example": "2013-03-07" }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "BirthDate\nDate on which a person was born.\n" } ] }, - "Issr": { + "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", @@ -9704,11 +8007,11 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, - "SchmeNm": { + "CityOfBirth": { "allOf": [ { "title": "Max35Text", @@ -9719,482 +8022,126 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "CityOfBirth\nCity where a person was born.\n" + } + ] + }, + "CtryOfBirth": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ - "Id", - "Issr" + "BirthDt", + "CityOfBirth", + "CtryOfBirth" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "ADDR" - } - }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "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": { + "Othr": { "allOf": [ { - "title": "GenericIdentification30", + "title": "GenericPersonIdentification1", "type": "object", - "description": "Generic scheme identification for a party.\n", + "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Issr": { + "SchmeNm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "SchmeNm": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -10205,117 +8152,182 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Id", - "Issr" + "Id" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Prtry" - ] + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + }, + { + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } + ] + } + }, + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + { + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" + } + ] + }, + "CtryOfRes": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" + } + ] + }, + "CtctDtls": { + "allOf": [ + { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "allOf": [ + { + "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" ], - "example": { - "Cd": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "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": "DOCT" }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + { + "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": 70, - "example": 1.2345678901234567e+99 + "maxLength": 140, + "example": 12345 }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PhneNb": { + "allOf": [ + { + "title": "PhoneNumber", "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + { + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + } + ] + }, + "MobNb": { + "allOf": [ + { + "title": "PhoneNumber", "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", + { + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + } + ] + }, + "FaxNb": { + "allOf": [ + { + "title": "PhoneNumber", "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + { + "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + } + ] + }, + "EmailAdr": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 2048, + "example": 2048 }, - "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", @@ -10323,7 +8335,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", @@ -10331,7 +8350,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", @@ -10339,312 +8365,236 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { + { + "description": "Responsibility\nRole of a person in an organisation.\n" + } + ] + }, + "Dept": { + "allOf": [ + { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 + }, + { + "description": "Department\nIdentification of a division of a large organisation or building.\n" } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } + ] }, - { - "description": "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": [ + "Othr": { + "allOf": [ + { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "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": "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": "BIC" - } + ] }, - { - "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": "Other\nContact details in another 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" + "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": [], - "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": { + "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": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + "Prtry": "DfspId" + } } } }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" } - ] + } }, - "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": "Party\nIdentification of a person or an organisation.\n" + } + ] + } + }, + "required": [ + "Pty" + ] + }, + { + "properties": { + "Agt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "description": "Information used to identify a financial institution.\n", + "properties": { + "BICFI": { + "allOf": [ + { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + } + ] }, - { - "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", + "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": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "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": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "minLength": 1, + "maxLength": 5, + "example": 12345 }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] - }, - "Issr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -10655,11 +8605,401 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\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": { + { + "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", @@ -10670,141 +9010,133 @@ "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": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum 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" } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "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": "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": 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": "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", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, - "DstrctNm": { + { + "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", @@ -10812,863 +9144,482 @@ "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": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } - }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } + ] }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] - } - }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } - } - }, - { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" - } - ] - } - }, - "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - } - }, - { - "description": "Financial institution servicing an account for the creditor.\n" - } - ] - } - }, - "required": [ - "Dbtr", - "Cdtr", - "DbtrAgt", - "CdtrAgt" - ] - }, - { - "description": "Underlying Customer Credit Transfer\nTBD\n" - } - ] - }, - "IntrBkSttlmAmt": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount_SimpleType", - "type": "string", - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", - "example": 123.45 - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" + "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\nIdentification of a financial institution.\n" + } ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" } + }, + "required": [ + "Agt" ] } - }, - "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" + "Pty": { + "Nm": "Name", + "PstlAdr": { + "Ctry": "US", + "AdrLine": [ + "Line1", + "Line2" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" } - ] + } }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" + "Agt": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" ] - }, - { - "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" + "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n" } ] }, - "ChrgBr": { - "title": "ChargeBearerType1Code", - "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", - "type": "string", - "enum": [ - "DEBT", - "CRED", - "SHAR" - ], - "example": "DEBT" - }, - "ChrgsInf": { + "Assgne": { "allOf": [ { - "title": "Charges16", - "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n", + "title": "Party40Choice", + "description": "Identification of a person, an organisation or a financial institution.\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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" + "anyOf": [ + { + "properties": { + "Pty": { + "allOf": [ + { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } ] }, - { - "description": "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", + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "anyOf": [ + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 5, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nClearing system identification code, as published in an external list.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "SchmeNm": { "allOf": [ { "title": "Max35Text", @@ -11679,163 +9630,306 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Prtry" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - ], - "example": { - "Cd": "CHIPS" - } - }, - { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" - } - ] - }, - "MmbId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "MmbId" ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Cd": "ADDR" } }, - { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "LEI\nLegal entity identifier of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } }, - "PstlAdr": { - "allOf": [ + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "anyOf": [ { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ + "OrgId": { + "allOf": [ { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", "properties": { - "Cd": { + "AnyBIC": { "allOf": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], + "title": "AnyBICDec2014Identifier", "type": "string", - "example": "ADDR" + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "LEI": { "allOf": [ { - "title": "GenericIdentification30", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericOrganisationIdentification1", "type": "object", - "description": "Generic scheme identification for a party.\n", + "description": "Information that locates and identifies an organisation.\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 for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, - "Issr": { + "SchmeNm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "SchmeNm": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -11846,461 +9940,226 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Id", - "Issr" + "Id" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] - }, - "Othr": { - "allOf": [ - { - "title": "GenericFinancialIdentification1", - "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Identification\nUnique and unambiguous identification of a person.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "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" - } - ] - } + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" }, - "required": [ - "Prtry" - ] + "Issr": "BIC" } - ], - "example": { - "Cd": "BIC" } }, { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" - } - ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 - }, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 - } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution 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 + "OrgId" + ] }, { - "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": [ + "PrvtId": { + "allOf": [ { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", "properties": { - "Cd": { + "DtAndPlcOfBirth": { "allOf": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "BirthDate\nDate on which a person was born.\n" + } + ] + }, + "PrvcOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ProvinceOfBirth\nProvince where a person was born.\n" + } + ] + }, + "CityOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "CityOfBirth\nCity where a person was born.\n" + } + ] + }, + "CtryOfBirth": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "CountryOfBirth\nCountry where a person was born.\n" + } + ] + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" ], - "type": "string", - "example": "ADDR" + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Othr": { "allOf": [ { - "title": "GenericIdentification30", + "title": "GenericPersonIdentification1", "type": "object", - "description": "Generic scheme identification for a party.\n", + "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Issr": { + "SchmeNm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "SchmeNm": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -12311,37 +10170,113 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Id", - "Issr" + "Id" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Prtry" - ] + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + }, + { + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } + ] + } + }, + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + { + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" + } + ] + }, + "CtryOfRes": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" + } + ] + }, + "CtctDtls": { + "allOf": [ + { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "allOf": [ + { + "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" ], - "example": { - "Cd": "ADDR" - } + "type": "string", + "example": "DOCT" }, - "CareOf": { + { + "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", @@ -12349,249 +10284,66 @@ "maxLength": 140, "example": 12345 }, - "Dept": { - "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}$" }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + { + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + } + ] + }, + "MobNb": { + "allOf": [ + { + "title": "PhoneNumber", "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 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": 140, - "example": 12345 + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "DstrctNm": { - "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", + { + "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": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, 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": 2048, + "example": 2048 }, - "AdrLine": { - "title": "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": "EmailAddress\nAddress for electronic mail (e-mail).\n" } - }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } + ] }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] - } - }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } - } - }, - { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" - } - ] - } - }, - "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - } - }, - { - "description": "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": { + "EmailPurp": { "allOf": [ { "title": "Max35Text", @@ -12602,11 +10354,11 @@ "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": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, - "Issr": { + "JobTitl": { "allOf": [ { "title": "Max35Text", @@ -12617,668 +10369,223 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "JobTitle\nTitle of the function.\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": { + "Rspnsblty": { "allOf": [ { - "title": "AnyBICDec2014Identifier", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 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" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "AnyBIC\nBusiness identification code of the organisation.\n" + "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, - "LEI": { + "Dept": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated 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": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, { - "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { - "title": "GenericOrganisationIdentification3", + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", "type": "object", - "description": "Information related to an identification of an organisation.\n", "properties": { - "Id": { + "ChanlTp": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 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" - } + "maxLength": 4, + "example": 1234 }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "Issr": { + "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": "Issuer\nEntity that assigns the identification.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Id" + "ChanlTp" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + "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": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" } }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ - "OrgId" - ] + "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": { - "PrvtId": { + "FinInstnId": { "allOf": [ { - "title": "PersonIdentification18", - "description": "Unique and unambiguous way to identify a person.\n", + "title": "FinancialInstitutionIdentification18", "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "DtAndPlcOfBirth": { + "BICFI": { "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": "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": "DateAndPlaceOfBirth\nDate and place of birth of a person.\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" } ] }, - "Othr": { + "ClrSysMmbId": { "allOf": [ { - "title": "GenericPersonIdentification2", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\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": { + "ClrSysId": { "allOf": [ { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", "anyOf": [ { @@ -13286,15 +10593,15 @@ "Cd": { "allOf": [ { - "title": "ExternalPersonIdentification1Code", - "description": "Specifies the external person 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" } ] } @@ -13316,7 +10623,7 @@ "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" } ] } @@ -13327,15 +10634,15 @@ } ], "example": { - "Cd": "CCPT" + "Cd": "CHIPS" } }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "Issr": { + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -13346,506 +10653,477 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "Id" + "MmbId" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" + "ClrSysId": { + "Cd": "CHQB" }, - "Issr": "BIC" + "MmbId": 123456789 } }, { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] - } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } - } - }, - { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" - } - ] - } - }, - "required": [ - "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 + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": "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": { + "Nm": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 + "maxLength": 140, + "example": 12345 }, { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, - "SchmeNm": { + "PstlAdr": { "allOf": [ { - "title": "AccountSchemeName1Choice", + "title": "PostalAddress24", "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": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Cd" + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "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" + } ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "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": "Proprietary\nName of the identification scheme, in a free text 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\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" ] } + }, + "required": [ + "Id" ], "example": { - "Cd": 1111 + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] + } + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "Issr": { + "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", @@ -13856,515 +11134,770 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" - } - ] - } - }, - "required": [ - "Othr" - ] - } - ], - "example": { - "IBAN": "BE71096123456769" - } - }, - { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" - } - ] - }, - "Tp": { - "allOf": [ - { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalCashAccountType1Code", - "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nAccount type, in a coded form.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "CACC" - } - }, - { - "description": "Type\nSpecifies the nature, or use of the account.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - { - "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" - } - ] - }, - "Prxy": { - "allOf": [ - { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", - "type": "object", - "properties": { - "Tp": { - "allOf": [ - { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { + "LEI": { "allOf": [ { - "title": "ExternalProxyAccountType1Code", - "description": "Specifies the external proxy account type 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": 4, - "example": 1234 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Code\nProxy account type, in a coded form as published in an external list.\n" + "description": "Legal Entity Identifier\nLegal entity identification for the branch 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\nProxy account type, in a proprietary form.\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": "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" + } + } + }, + { + "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } - ], - "example": { - "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": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\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": [ - "Id" - ], - "example": { - "Tp": { - "Cd": "IBAN" + } }, - "Id": 123 - } - }, - { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + { + "description": "Agent\nIdentification of a financial institution.\n" + } + ] } + }, + "required": [ + "Agt" ] } - }, + ], "example": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" + "Pty": { + "Nm": "Name", + "PstlAdr": { + "Ctry": "US", + "AdrLine": [ + "Line1", + "Line2" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + } + } }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 + "Agt": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } } } }, { - "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": "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" + } + } }, - "DbtrAgt": { + "Assgne": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + } + } + }, + "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" + }, + "ExternalVerificationReason1Code": { + "title": "ExternalVerificationReason1Code", + "description": "Specifies the external verification reason code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "VerificationReason1Choice": { + "title": "VerificationReason1Choice", + "type": "object", + "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalVerificationReason1Code", + "description": "Specifies the external verification reason code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + "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}$" + }, + "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 + }, + "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 + }, + "AccountSchemeName1Choice": { + "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 + } + }, + "GenericAccountIdentification1": { + "title": "GenericAccountIdentification1", + "type": "object", + "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "properties": { + "Id": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "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": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "description": "Information used to identify a financial institution.\n", - "properties": { - "BICFI": { - "allOf": [ - { - "title": "BICFIDec2014Identifier", - "type": "string", - "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - { - "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" - } - ] + "description": "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 }, - "ClrSysMmbId": { - "allOf": [ + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 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" + } + }, + "AccountIdentification4Choice": { + "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": [ { - "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": "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": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, - "MmbId": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -14375,86 +11908,535 @@ "example": 1.234567890123457e+34 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 - } - }, - { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "Prtry" + ] } - ] + ], + "example": { + "Cd": 1111 + } }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" - } - ] + { + "description": "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" + } + }, + "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 + }, + "CashAccountType2Choice": { + "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" + } + }, + "ActiveOrHistoricCurrencyCode": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + "ExternalProxyAccountType1Code": { + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "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" + } + }, + "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 }, - "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": "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 + } + }, + "CashAccount40": { + "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" } ] } @@ -14468,67 +12450,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" } ] } @@ -14539,106 +12469,17 @@ } ], "example": { - "Cd": "ADDR" + "Cd": 1111 } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -14646,480 +12487,341 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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" + ] } - ] - }, - "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" - } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - { - "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 + "Issr": "BIC" + } }, - "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": "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 }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + { + "description": "Code\nAccount type, in a coded form.\n" } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + ] } + }, + "required": [ + "Cd" ] }, - "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" - } - ] + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "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", + { + "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + { + "description": "Type\nSpecifies the nature, or use of the account.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "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": 140, - "example": 12345 + "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", @@ -15127,1178 +12829,206 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "Proprietary\nProxy account type, in a proprietary form.\n" } - }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + ] } + }, + "required": [ + "Prtry" ] } - }, + ], "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "Cd": "EMAIL" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Type\nType of the proxy identification.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + { + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ - "FinInstnId" + "Id" ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "Tp": { + "Cd": "IBAN" }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } + "Id": 123 } }, { - "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" }, - "CdtrAgt": { + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "IdentificationInformation4": { + "title": "IdentificationInformation4", + "type": "object", + "description": "Information that locates and identifies a specific party or account.\n", + "properties": { + "Pty": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FinInstnId": { + "Nm": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", "type": "object", - "description": "Information used to identify a financial institution.\n", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "BICFI": { - "allOf": [ - { - "title": "BICFIDec2014Identifier", - "type": "string", - "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - { - "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" - } - ] - }, - "ClrSysMmbId": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", "properties": { - "ClrSysId": { + "Cd": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "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" - } - ] - }, - "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": [ @@ -16310,14 +13040,6 @@ "Cd": "ADDR" } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", @@ -16335,12 +13057,12 @@ "example": 1.2345678901234567e+99 }, "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", @@ -16351,12 +13073,12 @@ "example": 1234567890123456 }, "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", @@ -16366,14 +13088,6 @@ "maxLength": 70, "example": 1.2345678901234567e+99 }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", @@ -16399,28 +13113,28 @@ "example": 1234567890123456 }, "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", @@ -16448,14 +13162,12 @@ }, "example": { "AdrTp": "ADDR", - "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", - "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", @@ -16468,15 +13180,15 @@ } }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", + "title": "Party38Choice", + "description": "Nature or use of the account.\n", "type": "object", "anyOf": [ { @@ -16484,7 +13196,7 @@ "OrgId": { "allOf": [ { - "title": "OrganisationIdentification39", + "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "properties": { @@ -16519,22 +13231,22 @@ "Othr": { "allOf": [ { - "title": "GenericOrganisationIdentification3", + "title": "GenericOrganisationIdentification1", "type": "object", - "description": "Information related to an identification of an organisation.\n", + "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 256, - "example": 256 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, @@ -16657,7 +13369,7 @@ "PrvtId": { "allOf": [ { - "title": "PersonIdentification18", + "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "properties": { @@ -16747,19 +13459,19 @@ "Othr": { "allOf": [ { - "title": "GenericPersonIdentification2", + "title": "GenericPersonIdentification1", "type": "object", - "description": "Identification of a person.", + "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 256, - "example": 256 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" @@ -16875,7 +13587,7 @@ } }, { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } @@ -16898,7 +13610,7 @@ } }, { - "description": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, @@ -16912,14 +13624,14 @@ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { - "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" + "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" } ] }, "CtctDtls": { "allOf": [ { - "title": "Contact13", + "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "properties": { @@ -16938,7 +13650,7 @@ "example": "DOCT" }, { - "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" + "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, @@ -16996,7 +13708,7 @@ } ] }, - "URLAdr": { + "EmailAdr": { "allOf": [ { "title": "Max2048Text", @@ -17006,21 +13718,6 @@ "maxLength": 2048, "example": 2048 }, - { - "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" - } - ] - }, - "EmailAdr": { - "allOf": [ - { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 - }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } @@ -17133,15 +13830,15 @@ } }, { - "description": "OtherContact\nContact details in another form.\n" + "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { - "title": "PreferredContactMethod2Code", - "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", @@ -17150,10 +13847,10 @@ "FAXX", "CELL" ], - "example": "MAIL" + "example": "CELL" }, { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } @@ -17164,12 +13861,11 @@ "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", - "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } @@ -17185,19 +13881,25 @@ "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry" + "Ctry": "Ctry", + "AdrLine": "AdrLine" }, "Id": { "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "Othr": { + "Id": 123, + "SchmeNm": { + "Prtry": "DfspId" + } } } }, @@ -17213,11 +13915,11 @@ } }, { - "description": "Creditor\nParty to which an amount of money is due.\n" + "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, - "CdtrAcct": { + "Acct": { "allOf": [ { "title": "CashAccount40", @@ -17756,526 +14458,589 @@ } }, { - "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" + "description": "Account\nUnambiguous identification of the account of a party.\n" } ] }, - "RgltryRptg": { + "Agt": { "allOf": [ { - "title": "RegulatoryReporting3", - "description": "Information needed due to regulatory and/or statutory requirements.\n", + "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "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": { + "FinInstnId": { "allOf": [ { - "title": "RegulatoryAuthority2", - "description": "Information about an entity requiring the regulatory reporting information.\n", + "title": "FinancialInstitutionIdentification18", "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "Nm": { + "BICFI": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "BICFIDec2014Identifier", "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" }, { - "description": "Name\n\nName of the entity requiring the regulatory reporting information.\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" } ] }, - "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": { + "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": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\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 related to the specified type of regulatory reporting details.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, - "Ctry": { + "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\n\nCountry related to the specified type of regulatory reporting details.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, - "Cd": { + "PstlAdr": { "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": "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\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "Amt": { + "Othr": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "GenericFinancialIdentification1", "type": "object", - "description": "A number 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": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\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 person.\n" } ] }, - "Ccy": { + "SchmeNm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "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", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "Id" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] + } + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "Inf": { - "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", - "anyOf": [ + "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", @@ -18285,324 +15050,190 @@ "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": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] - } - }, - "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})$" + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-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" + } + ] + } }, - { - "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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" - } - }, - { - "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": { + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -18610,410 +15241,1536 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "type": "array" + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } - ] - } - }, - "example": { - "Tp": "T1", - "Dt": "2018-01-01", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 - }, - "Inf": 12345 + }, + { + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] } }, - "type": "array" + "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": { - "DbtCdtRptgInd": "CRED", - "Authrty": { - "Nm": "Swiss National Bank", - "Ctry": "CH" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Dtls": { - "Cd": "A1", - "Inf": "Mandatory regulatory information" + "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": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" + "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" + } + } + } + }, + "VerificationReport4": { + "title": "VerificationReport4", + "type": "object", + "description": "VerificationReport\nProvides information about the verification of party and/or account identification information.", + "properties": { + "OrgnlId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "OriginalIdentification\nUnique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message.\n" } ] }, - "Tax": { + "Vrfctn": { "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": "IdentificationVerificationIndicator", + "type": "boolean", + "example": true, + "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n" + }, + { + "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n" + } + ] + }, + "Rsn": { + "allOf": [ + { + "title": "VerificationReason1Choice", "type": "object", - "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" - } - ] + "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalVerificationReason1Code", + "description": "Specifies the external verification reason code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, - "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" - } - ] + { + "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\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" + ] } + }, + "required": [ + "Cd" ] }, - "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" - } - ] + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "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": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n" } - } - }, - { - "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" + ] } + }, + "required": [ + "Prtry" ] - }, - "UltmtDbtr": { + } + ], + "example": { + "Cd": "AGNT" + } + }, + { + "description": "Reason\nSpecifies the reason why the verified identification information is incorrect.\n" + } + ] + }, + "OrgnlPtyAndAcctId": { + "allOf": [ + { + "title": "IdentificationInformation4", + "type": "object", + "description": "Information that locates and identifies a specific party or account.\n", + "properties": { + "Pty": { "allOf": [ { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\n", + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\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": { + "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": "TaxType\n\nType of tax payer.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, - "Authstn": { + "PstlAdr": { "allOf": [ { - "title": "TaxAuthorisation1", - "description": "Details of an authorised tax paying party.\n", + "title": "PostalAddress24", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Titl": { - "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": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\n\nName of the debtor or the debtor's authorised representative.\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": { - "Titl": "Mr", - "Nm": "John Doe" + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\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 + }, + "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": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n" + "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, - "TtlTaxblBaseAmt": { + "Acct": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "CashAccount40", "type": "object", - "description": "A number 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": "Provides the details to identify an account.\n", "properties": { - "ActiveOrHistoricCurrencyAndAmount": { + "Id": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", - "type": "string", - "example": 123.45, - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\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": "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": "Amount of 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 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" } ] }, @@ -19194,4354 +16951,3899 @@ ] }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" } ] - } - }, - "required": [ - "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": { + }, + "Nm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 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": 70, + "example": 1.2345678901234567e+99 }, { - "description": "Amount of 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 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" } ] }, - "Ccy": { + "Prxy": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } } }, { - "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" - } - ] - }, - "Dt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "Date\n\nDate by which tax is due.\n" + "description": "Account\nUnambiguous identification of the account of a party.\n" } ] }, - "SeqNb": { + "Agt": { "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", + "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\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": { + "FinInstnId": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "FinancialInstitutionIdentification18", "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, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, - "TaxAmt": { + "BrnchId": { "allOf": [ { - "title": "TaxAmount3", - "description": "Information on the amount of the tax record.\n", + "title": "BranchData3", "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\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 branch of a financial institution.\n" } ] }, - "TaxblBaseAmt": { + "LEI": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-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": "A number 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": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\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": "Currency\nIdentification of the currency in which the account is held.\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": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] - }, - "TtlAmt": { - "allOf": [ + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + }, + { + "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Agent\nFinancial institution servicing an account for a party.\n" + } + ] + } + }, + "required": [ + "Pty" + ], + "example": { + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" + }, + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } + } + } + }, + { + "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n" + } + ] + }, + "UpdtdPtyAndAcctId": { + "allOf": [ + { + "title": "IdentificationInformation4", + "type": "object", + "description": "Information that locates and identifies a specific party or account.\n", + "properties": { + "Pty": { + "allOf": [ + { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { - "ActiveOrHistoricCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", - "type": "string", - "example": 123.45, - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" - }, - { - "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" - } - ] - }, - "Ccy": { + "Cd": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "Cd" + ] }, { - "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" - } - ] - }, - "Dtls": { - "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", - "anyOf": [ - { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", - "type": "object", "properties": { - "Prd": { + "Prtry": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "GenericIdentification30", "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "FrToDt": { + "Id": { "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" - } + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "Tp": { + "Issr": { "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": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Type\n\nIdentification of the period related to the tax payment.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "Yr": { + "SchmeNm": { "allOf": [ { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Year\n\nYear related to the tax payment.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, + "required": [ + "Id", + "Issr" + ], "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" + } + }, + "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" + } ] }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\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" }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "Issr": "BIC" } - ] - } - }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" } }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" + { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\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": [ + "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" }, - "required": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + { + "description": "BirthDate\nDate on which a person was born.\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" - } - ] + ] + }, + "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" + } + ] + } }, - "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": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" } }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + { + "description": "DateAndPlaceOfBirth\nDate and place of birth 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" - } - ] - }, - "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" - } - ] + ] + }, + "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" + } + ] + } }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" } }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + { + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\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" + "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" } - }, - "type": "array" + ] } + }, + "required": [ + "PrvtId" ] } - }, + ], "example": { - "Rate": 0, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 0 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 0 + "OrgId": { + "AnyBIC": "BIC" }, - "Dtls": { - "Tp": "T1", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 - }, - "Inf": 12345 + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } } }, { - "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, - "Tp": { + "CtryOfRes": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "CountryCode", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { - "description": "Type\n\nHigh level code to identify the type of tax details.\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": { - "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" - } + "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" }, - "TaxAmt": { - "Rate": 0.2, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 1000 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 200 + "Id": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Prtry": "DfspId" + } + } } }, - "AddtlInf": "VAT applicable" + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "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" - } - ] - }, - "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": "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" + } + ] + } }, - "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": "IBAN" + }, + "Issr": "BIC" } }, - "required": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + { + "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } - }, - { - "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" - } - ] - }, - "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": [ + "Othr" + ] } - }, - { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + ], + "example": { + "IBAN": "BE71096123456769" } - ] - }, - "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": "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" + } + ] + } }, - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "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\nNature or use of the account in a proprietary form.\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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" - } - ] - }, - "Dtls": { - "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", - "anyOf": [ - { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", - "type": "object", - "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": "CACC" + } + }, + { + "description": "Type\nSpecifies the nature, or use of the account.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "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 }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + { + "description": "Code\nProxy account type, 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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "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": "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" + ] } - }, - { - "items": { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", - "type": "object", - "properties": { - "Prd": { - "allOf": [ + ], + "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": [ { - "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": { + "Cd": { "allOf": [ { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", "type": "string", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 + "minLength": 1, + "maxLength": 5, + "example": 12345 }, { - "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" - } - } + "required": [ + "Cd" + ] }, { - "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": { + "Prtry": { "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": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" + } + }, + "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": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "Cd" + ] }, { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\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": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + ], + "example": { + "Cd": "BIC" } }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" + { + "description": "SchemeName\nName of the identification scheme.\n" } - } + ] }, - "type": "array" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "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": { - "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": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + } + ] } }, - { - "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" - } - ] - }, - "Tp": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Type\n\nHigh level code to identify the type of tax details.\n" + "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 + } } - ] - } - }, - "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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", - "type": "string", - "pattern": "^[A-Za-z0-9-_]{43}$", - "maxLength": 48 - }, - { - "description": "SHA-256 signature of the terms\n" - } - ] - } - }, - "required": [ - "Sh256Sgntr" - ] - } - ], - "example": { - "IlpV4PrepPacket": "1234567890ABCDEF" - } - } - }, - "required": [ - "PmtId", - "IntrBkSttlmAmt", - "ChrgBr", - "Dbtr", - "DbtrAgt", - "CdtrAgt", - "Cdtr" - ], - "example": { - "PmtId": { - "InstrId": "INSTRID", - "EndToEndId": "ENDTOENDID" - }, - "PmtTpInf": { - "LclInstrm": { - "Cd": "CHQB", - "Prtry": "PROPRIETARY" - }, - "SeqTp": "SEQTP" - }, - "IntrBkSttlmAmt": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" - }, - "InstdAmt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - }, - "XchgRate": 123.45, - "ChrgBr": "SHAR", - "ChrgsInf": { - "Amt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - }, - "Agt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "Tp": { - "Cd": "SHAR" - } - }, - "Dbtr": { - "Nm": "NAME", - "PstlAdr": { - "AdrTp": "ADDR", - "BldgNb": "BLDGNB", - "Ctry": "CTRY", - "TwnNm": "TWNNM", - "PstCd": "PSTCD", - "StrtNm": "STRTNM" - } - }, - "DbtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "DbtrAgt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "CdtrAgt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "Cdtr": { - "Nm": "NAME", - "PstlAdr": { - "AdrTp": "ADDR", - "BldgNb": "BLDGNB", - "Ctry": "CTRY", - "TwnNm": "TWNNM", - "PstCd": "PSTCD", - "StrtNm": "STRTNM" - } - }, - "CdtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "InstrForCdtrAgt": { - "Cd": "CODE" - }, - "InstrForNxtAgt": { - "Cd": "CODE" - }, - "Purp": { - "Cd": "CASH" - }, - "RgltryRptg": { - "Dbtr": true, - "Cdtr": true - }, - "Tax": "Cdtr" - } - }, - "CreditTransferTransaction68": { - "title": "CreditTransferTransaction68", - "description": "Provides further details specific to the individual transaction(s) included in the message.\n", - "type": "object", - "properties": { - "PmtId": { - "allOf": [ - { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", - "type": "object", - "properties": { - "InstrId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" - }, - { - "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" - } - ] - }, - "ClrSysRef": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" - } - ] - } - }, - "required": [ - "TxId" - ], - "example": { - "InstrId": "INSTRUCTIONID", - "EndToEndId": "ENDTOENDID", - "TxId": "TRANSACTIONID", - "UETR": "123e4567-e89b-12d3-a456-426614174000", - "ClrSysRef": "CLRSYSREF" - } - }, - { - "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" - } - ] - }, - "PmtTpInf": { - "allOf": [ - { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", - "type": "object", - "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 + "BrnchId": { + "allOf": [ + { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + } + ] }, - { - "description": "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 + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" + } + ] }, - { - "description": "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 + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 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": "Proprietary\nSpecifies the local instrument, as a proprietary code.\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": [ - "Prtry" ] } + }, + "required": [ + "FinInstnId" ], "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" - ] + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nCategory purpose, in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } } - ], - "example": { - "Cd": "CASH" } }, { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "description": "Agent\nFinancial institution servicing an account for a party.\n" } ] } }, + "required": [ + "Pty" + ], "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" }, - "LclInstrm": { - "Cd": "CORE" + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } }, - "CtgyPurp": { - "Cd": "CASH" + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } } } }, { - "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" + "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n" } ] + } + }, + "required": [ + "OrgnlId", + "Vrfctn", + "UpdtdPtyAndAcctId" + ], + "example": { + "OrgnlId": 1.2345678901234568e+33, + "Vrfctn": true, + "OrgnlPtyAndAcctId": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "1234 Elm St", + "BldgNb": 1234, + "PstCd": 12345, + "TwnNm": "Anytown", + "CtrySubDvsn": "CA", + "Ctry": "US" + }, + "Id": { + "OrgId": { + "AnyBIC": "ABCDUS33", + "Othr": { + "Id": 123456789, + "Issr": "ABA" + } + } + } }, - "UndrlygCstmrCdtTrf": { + "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" + } + } + } + } + } + }, + "Max350Text": { + "title": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 350, + "example": 350 + }, + "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" + }, + "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": "UnderlyingCustomerCreditTransfer", + "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" + } + } + }, + "GetParties_IdentificationVerificationReportV03": { + "title": "GetParties_IdentificationVerificationReportV03", + "type": "object", + "properties": { + "Assgnmt": { + "allOf": [ + { + "title": "IdentificationAssignment3", "type": "object", + "description": "IdentificationAssignment\nInformation that unambiguously identifies a message, as assigned by the assignor to the assignee.\n", "properties": { - "InstdAmt": { + "MsgId": { "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "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": "MessageIdentification\nUnique identification, as assigned by the assigner, to unambiguously identify the message.\n" } ] }, - "Dbtr": { + "CreDtTm": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\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 identification assignment was created.\n" + } + ] + }, + "Assgnr": { + "allOf": [ + { + "title": "Party40Choice", + "description": "Identification of a person, an organisation or a financial institution.\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", + "anyOf": [ + { + "properties": { + "Pty": { + "allOf": [ + { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\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" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\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": "GenericIdentification30", + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "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": [ + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "GenericOrganisationIdentification3", - "type": "object", - "description": "Information related to an identification of an organisation.\n", "properties": { - "Id": { + "Cd": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 + "example": "ADDR" }, { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "SchmeNm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", + "title": "GenericIdentification30", "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification code.", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 4, + "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "Prtry": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -23552,233 +20854,475 @@ "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" } ] - } - }, - "anyOf": [ - { - "properties": { - "Cd": {} - } }, - { - "properties": { - "Prtry": {} - } + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] } + }, + "required": [ + "Id", + "Issr" ], "example": { - "Cd": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } }, "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] - } - }, - "required": [ - "OrgId" - ] - }, - { - "properties": { - "PrvtId": { + }, + "Id": { "allOf": [ { - "title": "PersonIdentification18", - "description": "Unique and unambiguous way to identify a person.\n", + "title": "Party38Choice", + "description": "Nature or use of the account.\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" + "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" + } + ] }, - { - "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 + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[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": "ProvinceOfBirth\nProvince where a person was born.\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" + } + ] } - ] - }, - "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" + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "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": "Organisation\nUnique and unambiguous way to identify an organisation.\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": [ + "OrgId" ] }, - "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": { + "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": { - "Cd": { + "BirthDt": { "allOf": [ { - "title": "ExternalPersonIdentification1Code", - "description": "Specifies the external person 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" + } + ] + }, + "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": [ - "Cd" - ] + "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": { - "Prtry": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -23789,943 +21333,555 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "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" - ] + "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": "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 + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] - } - }, - "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": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" + } + ] } + }, + "required": [ + "PrvtId" ] } - }, + ], "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "OrgId": { + "AnyBIC": "BIC" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" } } } }, { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "Identification\nUnique and unambiguous way to identify an organisation.\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" - } - ] + "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" }, - "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" - } - ] + { + "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "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": { + "CtctDtls": { "allOf": [ { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", "type": "object", "properties": { - "AnyBIC": { + "NmPrfx": { "allOf": [ { - "title": "AnyBICDec2014Identifier", + "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", - "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" + "example": "DOCT" }, { - "description": "AnyBIC\nBusiness identification code of the organisation.\n" + "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, - "LEI": { + "Nm": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated 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": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "description": "LEI\nLegal entity identification as an alternate identification for a party.\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", + "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": "GenericOrganisationIdentification3", + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", "type": "object", - "description": "Information related to an identification of an organisation.\n", "properties": { - "Id": { + "ChanlTp": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 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" - } + "maxLength": 4, + "example": 1234 }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "Issr": { + "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": "Issuer\nEntity that assigns the identification.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Id" + "ChanlTp" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + "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": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" } }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "ContactDetails\nSet of elements used to indicate how to contact the 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": { + "Id" + ], + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + }, + "Id": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Prtry": "DfspId" + } + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + { + "description": "Party\nIdentification of a person or an organisation.\n" + } + ] + } + }, + "required": [ + "Pty" + ] + }, + { + "properties": { + "Agt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "description": "Information used to identify a financial institution.\n", + "properties": { + "BICFI": { + "allOf": [ + { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + } + ] + }, + "ClrSysMmbId": { + "allOf": [ + { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { "allOf": [ { - "title": "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": "ProvinceOfBirth\nProvince where a person was born.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "CityOfBirth": { + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -24736,58 +21892,333 @@ "example": 1.234567890123457e+34 }, { - "description": "CityOfBirth\nCity where a person was born.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - "CtryOfBirth": { - "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": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\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": "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" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "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": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" - ], "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { - "title": "GenericPersonIdentification2", + "title": "GenericFinancialIdentification1", "type": "object", - "description": "Identification of a person.", + "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": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 256, - "example": 256 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" @@ -24797,17 +22228,17 @@ "SchmeNm": { "allOf": [ { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", + "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalPersonIdentification1Code", - "description": "Specifies the external person identification code.", + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, @@ -24847,7 +22278,7 @@ } ], "example": { - "Cd": "CCPT" + "Cd": "BIC" } }, { @@ -24877,835 +22308,528 @@ "example": { "Id": 123, "SchmeNm": { - "Cd": "DRLC" + "Cd": "IBAN" }, "Issr": "BIC" } }, { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, + "required": [], "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "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": "CUST", - "Prtry": 1 - } + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\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 + "BrnchId": { + "allOf": [ + { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + } + ] }, - { - "description": "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 + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" + } + ] }, - { - "description": "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": [ + "Nm": { + "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": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Prtry": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, { - "description": "Proprietary\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" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Id", - "Issr" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Cd": "ADDR" } }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "ADDR" + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "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 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } - }, - "example": { + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } - ] + } }, - "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": "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 }, - "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", + { + "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": "Specifies the name of the identification scheme.\n", + "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution 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" } ] } @@ -25719,15 +22843,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" } ] } @@ -25738,17 +22914,42 @@ } ], "example": { - "Cd": "BIC" + "Cd": "ADDR" } }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -25756,918 +22957,1354 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "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": "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress27", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "Id": { + "allOf": [ + { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", "type": "object", - "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { - "Cd": { + "OrgId": { "allOf": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "allOf": [ + { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "AnyBIC\nBusiness identification code of the organisation.\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericOrganisationIdentification1", + "type": "object", + "description": "Information that locates and identifies an organisation.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + } + ] + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ - "Cd" + "OrgId" ] }, { "properties": { - "Prtry": { + "PrvtId": { "allOf": [ { - "title": "GenericIdentification30", + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", "type": "object", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "BirthDate\nDate on which a person was born.\n" + } + ] + }, + "PrvcOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ProvinceOfBirth\nProvince where a person was born.\n" + } + ] + }, + "CityOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "CityOfBirth\nCity where a person was born.\n" + } + ] + }, + "CtryOfBirth": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "CountryOfBirth\nCountry where a person was born.\n" + } + ] + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, - "SchmeNm": { + "Othr": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "GenericPersonIdentification1", + "type": "object", + "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Id", - "Issr" - ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ - "Prtry" + "PrvtId" ] } ], "example": { - "Cd": "ADDR" + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "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": { + { + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" + } + ] + }, + "CtryOfRes": { + "allOf": [ + { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" } - }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "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": [ + "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": { - "Cd": { + "ChanlTp": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", "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": "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\nProprietary identification of the clearing system.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Prtry" - ] + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + { + "description": "Other\nContact details in another form.\n" } - ], - "example": { - "Cd": "CHIPS" - } + ] }, - { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\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" + } }, - "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": "ContactDetails\nSet of elements used to indicate how to contact the party.\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" + }, + "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": "LEI\nLegal entity identifier of the financial institution.\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" } - ] + } }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "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", + { + "description": "Party\nIdentification of a person or an organisation.\n" + } + ] + } + }, + "required": [ + "Pty" + ] + }, + { + "properties": { + "Agt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification18", "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] + "description": "Information used to identify a financial institution.\n", + "properties": { + "BICFI": { + "allOf": [ + { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ + "ClrSysMmbId": { + "allOf": [ + { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + { + "description": "Code\nClearing system identification code, as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" + } + ] + }, + "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" ] }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Id", - "Issr" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Cd": "ADDR" } }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } - }, - "required": [ - "Prtry" ] - } - ], - "example": { - "Cd": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] - }, - "Othr": { - "allOf": [ - { - "title": "GenericFinancialIdentification1", - "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 }, - { - "description": "Identification\nUnique and unambiguous identification of a person.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "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": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "SchmeNm": { + "allOf": [ + { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -26678,201 +24315,697 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Prtry" - ] + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } - ], - "example": { - "Cd": "BIC" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" + ] } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + } }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" - } - ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 - }, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 - } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" - } - ] - }, - "BrnchId": { - "allOf": [ - { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "type": "object", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" - }, - { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + { + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" + } + ] }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress27", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "BrnchId": { + "allOf": [ + { + "title": "BranchData3", "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-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\nIdentification of a financial institution.\n" + } + ] + } + }, + "required": [ + "Agt" + ] + } + ], + "example": { + "Pty": { + "Nm": "Name", + "PstlAdr": { + "Ctry": "US", + "AdrLine": [ + "Line1", + "Line2" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + } + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + } + }, + { + "description": "Assignee\nParty that the identification assignment is assigned to. This is also the receiver of the message.\n" + } + ] + } + }, + "required": [ + "MsgId", + "CreDtTm", + "Assgnr", + "Assgne" + ], + "example": { + "MsgId": 123, + "CreDtTm": "2020-01-01T00:00:00Z", + "Assgnr": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "Assgne": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + } + } + }, + { + "description": "Assignment\nIdentifies the identification assignment.\n" + } + ] + }, + "Rpt": { + "allOf": [ + { + "title": "VerificationReport4", + "type": "object", + "description": "VerificationReport\nProvides information about the verification of party and/or account identification information.", + "properties": { + "OrgnlId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "OriginalIdentification\nUnique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message.\n" + } + ] + }, + "Vrfctn": { + "allOf": [ + { + "title": "IdentificationVerificationIndicator", + "type": "boolean", + "example": true, + "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n" + }, + { + "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n" + } + ] + }, + "Rsn": { + "allOf": [ + { + "title": "VerificationReason1Choice", + "type": "object", + "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalVerificationReason1Code", + "description": "Specifies the external verification reason code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + { + "description": "Reason\nSpecifies the reason why the verified identification information is incorrect.\n" + } + ] + }, + "OrgnlPtyAndAcctId": { + "allOf": [ + { + "title": "IdentificationInformation4", + "type": "object", + "description": "Information that locates and identifies a specific party or account.\n", + "properties": { + "Pty": { + "allOf": [ + { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "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" @@ -26935,14 +25068,6 @@ "Cd": "ADDR" } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", @@ -26960,12 +25085,12 @@ "example": 1.2345678901234567e+99 }, "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", @@ -26976,12 +25101,12 @@ "example": 1234567890123456 }, "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", @@ -26991,14 +25116,6 @@ "maxLength": 70, "example": 1.2345678901234567e+99 }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", @@ -27024,28 +25141,28 @@ "example": 1234567890123456 }, "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", @@ -27073,14 +25190,12 @@ }, "example": { "AdrTp": "ADDR", - "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", - "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", @@ -27096,1325 +25211,1382 @@ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] - } - }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } - } - }, - { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" - } - ] - } - }, - "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - } - }, - { - "description": "Financial institution servicing an account for the creditor.\n" - } - ] - } - }, - "required": [ - "Dbtr", - "Cdtr", - "DbtrAgt", - "CdtrAgt" - ] - }, - { - "description": "Underlying Customer Credit Transfer\nTBD\n" - } - ] - }, - "IntrBkSttlmAmt": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount_SimpleType", - "type": "string", - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", - "example": 123.45 - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" - } - ] - }, - "Dbtr": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "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": { + }, + "Id": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "title": "Party38Choice", + "description": "Nature or use of the account.\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": { + "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\nProprietary identification of the clearing system.\n" - } - ] - } - }, + "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": [ - "Prtry" + "OrgId" + ] + }, + { + "properties": { + "PrvtId": { + "allOf": [ + { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "BirthDate\nDate on which a person was born.\n" + } + ] + }, + "PrvcOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ProvinceOfBirth\nProvince where a person was born.\n" + } + ] + }, + "CityOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "CityOfBirth\nCity where a person was born.\n" + } + ] + }, + "CtryOfBirth": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "CountryOfBirth\nCountry where a person was born.\n" + } + ] + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + { + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericPersonIdentification1", + "type": "object", + "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + } + ] + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + }, + { + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" + } + ] + } + }, + "required": [ + "PrvtId" ] } ], "example": { - "Cd": "CHIPS" + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } } }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, - "MmbId": { + "CtryOfRes": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "CountryCode", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\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": [ - "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": [ + "CtctDtls": { + "allOf": [ { + "title": "Contact4", + "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\nName prefix to be used before the name of the person.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Nm": { "allOf": [ { - "title": "GenericIdentification30", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 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", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { + "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": "Issuer\nEntity that assigns the identification.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "SchmeNm": { + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Id", - "Issr" + "ChanlTp" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "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", + "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, - "Othr": { + "Acct": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "CashAccount40", "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Identification\nUnique and unambiguous identification of a person.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "AccountIdentification4Choice", "type": "object", - "description": "Specifies the name of the identification scheme.\n", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { - "Cd": { + "IBAN": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", + "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", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "example": "FR1420041010050500013M02606", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\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": [ - "Cd" + "IBAN" ] }, { "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\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": [ + "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" + } + }, { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\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\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" ] } - }, - "required": [ - "Cd" + ], + "example": { + "Cd": "CACC" + } + }, + { + "description": "Type\nSpecifies the nature, or use of the account.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" ] }, { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", "properties": { - "Prtry": { + "Tp": { "allOf": [ { - "title": "GenericIdentification30", + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy 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": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "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" ] }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum 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\nProxy account type, in a proprietary form.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Id", - "Issr" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Cd": "EMAIL" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\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": [ - "Prtry" - ] + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + }, + { + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\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": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } } }, { - "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" - } - ] + "description": "Account\nUnambiguous identification of the account of a party.\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 + "Agt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "description": "Information used to identify a financial institution.\n", + "properties": { + "BICFI": { + "allOf": [ + { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + } + ] }, - { - "description": "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": [ + "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": "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 + "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\nName of the identification scheme, in a coded form as published in an external 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", @@ -28425,517 +26597,206 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\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": 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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - { - "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" - } - ] - }, - "Prxy": { - "allOf": [ - { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", - "type": "object", - "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 + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": "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 + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 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": "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", + "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": 5, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Code\nClearing system identification code, as published in an external list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -28943,164 +26804,194 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] - } - }, - "required": [ - "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" + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "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\nType of address expressed as a code.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Othr": { "allOf": [ { - "title": "GenericIdentification30", + "title": "GenericFinancialIdentification1", "type": "object", - "description": "Generic scheme identification for a party.\n", + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Issr": { + "SchmeNm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "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": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "SchmeNm": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -29111,236 +27002,266 @@ "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": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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 + } + } + }, + { + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary 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 - } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "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": { + "BrnchId": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "BranchData3", "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 branch of a financial institution.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -29348,937 +27269,1410 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "BIC" + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "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": "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": [ - "Id" + "FinInstnId" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Issr": "BIC" + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } } }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "Agent\nFinancial institution servicing an account for a party.\n" } ] } }, - "required": [], + "required": [ + "Pty" + ], "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" }, - "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" + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } } } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n" } ] }, - "BrnchId": { + "UpdtdPtyAndAcctId": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "IdentificationInformation4", "type": "object", + "description": "Information that locates and identifies a specific party or account.\n", "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "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": { + "Pty": { "allOf": [ { - "title": "PostalAddress27", + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\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 }, { + "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": { - "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": "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": { + "Id": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "title": "Party38Choice", + "description": "Nature or use of the account.\n", "type": "object", "anyOf": [ { "properties": { - "Cd": { + "OrgId": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", - "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "allOf": [ + { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "AnyBIC\nBusiness identification code of the organisation.\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericOrganisationIdentification1", + "type": "object", + "description": "Information that locates and identifies an organisation.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + } + ] + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } }, { - "description": "Code\nClearing system identification code, 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": "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": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ - "Prtry" + "PrvtId" ] } ], "example": { - "Cd": "CHIPS" + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } } }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, - "MmbId": { + "CtryOfRes": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "CountryCode", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\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": [ - "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": [ + "CtctDtls": { + "allOf": [ { + "title": "Contact4", + "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\nName prefix to be used before the name of the person.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Nm": { "allOf": [ { - "title": "GenericIdentification30", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 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", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { + "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": "Issuer\nEntity that assigns the identification.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "SchmeNm": { + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Id", - "Issr" + "ChanlTp" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "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", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 + "Id": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Prtry": "DfspId" + } + } + } }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "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": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "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": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, - "Othr": { + "Acct": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "CashAccount40", "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "anyOf": [ + { + "properties": { + "IBAN": { + "allOf": [ + { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "example": "FR1420041010050500013M02606", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" + }, + { + "description": "IBAN\nInternational Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions.\n" + } + ] + } + }, + "required": [ + "IBAN" + ] + }, + { + "properties": { + "Othr": { + "allOf": [ + { + "title": "GenericAccountIdentification1", + "type": "object", + "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + { + "description": "Identification\nIdentification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + } + ] + } + }, + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, - "SchmeNm": { + "Tp": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\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": "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\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Code\nAccount type, in a coded form.\n" } ] } @@ -30300,7 +28694,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } @@ -30311,212 +28705,426 @@ } ], "example": { - "Cd": "BIC" + "Cd": "CACC" } }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, - "Issr": { + "Ccy": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "allOf": [ + { + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nProxy account type, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nProxy account type, in a proprietary form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "EMAIL" + } + }, + { + "description": "Type\nType of the proxy identification.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + { + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + }, + { + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, - "required": [ - "Id" - ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + "Id": { + "IBAN": "BE71096123456769" }, - "Issr": "BIC" + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } } }, { - "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" + "description": "Account\nUnambiguous identification of the account of a party.\n" } ] }, - "PstlAdr": { + "Agt": { "allOf": [ { - "title": "PostalAddress27", + "title": "BranchAndFinancialInstitutionIdentification6", "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": "FinancialInstitutionIdentification18", + "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": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { + "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": "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" } ] }, - "SchmeNm": { + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -30527,317 +29135,206 @@ "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] - } - }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } - } - }, - { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" - } - ] - } - }, - "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - } - }, - { - "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" - } - ] - }, - "Cdtr": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "description": "Information used to identify a financial institution.\n", - "properties": { - "BICFI": { - "allOf": [ - { - "title": "BICFIDec2014Identifier", - "type": "string", - "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - { - "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" - } - ] - }, - "ClrSysMmbId": { - "allOf": [ - { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", - "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 - }, - { - "description": "Code\nClearing system identification code, as published in an external list.\n" - } - ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": [ - { + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "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", @@ -30845,164 +29342,194 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] - } - }, - "required": [ - "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" + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "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\nType of address expressed as a code.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Othr": { "allOf": [ { - "title": "GenericIdentification30", + "title": "GenericFinancialIdentification1", "type": "object", - "description": "Generic scheme identification for a party.\n", + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Issr": { + "SchmeNm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "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": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "SchmeNm": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -31013,447 +29540,839 @@ "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": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] - }, - "Othr": { - "allOf": [ - { - "title": "GenericFinancialIdentification1", - "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Identification\nUnique and unambiguous identification of a person.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "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" - ] + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\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": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "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": [ - "Prtry" - ] + "Issr": 123 } - ], - "example": { - "Cd": "BIC" } }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, - "Issr": { + "BrnchId": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "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": [ - { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "example": "ADDR" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "LEI": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "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", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + }, + { + "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Agent\nFinancial institution servicing an account for a party.\n" + } + ] + } + }, + "required": [ + "Pty" + ], + "example": { + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" + }, + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } + } + } + }, + { + "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n" + } + ] + } + }, + "required": [ + "OrgnlId", + "Vrfctn", + "UpdtdPtyAndAcctId" + ], + "example": { + "OrgnlId": 1.2345678901234568e+33, + "Vrfctn": true, + "OrgnlPtyAndAcctId": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "1234 Elm St", + "BldgNb": 1234, + "PstCd": 12345, + "TwnNm": "Anytown", + "CtrySubDvsn": "CA", + "Ctry": "US" + }, + "Id": { + "OrgId": { + "AnyBIC": "ABCDUS33", + "Othr": { + "Id": 123456789, + "Issr": "ABA" + } + } + } + }, + "UpdtdPtyAndAcctId": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "1234 Elm St", + "BldgNb": 1234, + "PstCd": 12345, + "TwnNm": "Anytown", + "CtrySubDvsn": "CA", + "Ctry": "US" + }, + "Id": { + "OrgId": { + "AnyBIC": "ABCDUS33", + "Othr": { + "Id": 123456789, + "Issr": "ABA" + } + } + } + } + } + }, + { + "description": "Report\nInformation concerning the verification of the identification data for which verification was requested.\n" + } + ] + }, + "SplmtryData": { + "allOf": [ + { + "title": "SupplementaryData1", + "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "properties": { + "PlcAndNm": { + "allOf": [ + { + "title": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 350, + "example": 350 + }, + { + "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" + } + ] + }, + "Envlp": { + "allOf": [ + { + "title": "SupplementaryDataEnvelope1", + "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n", + "type": "object" + }, + { + "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n" + } + ] + } + }, + "required": [ + "Envlp" + ], + "example": { + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } + } + }, + { + "description": "SupplementaryData\nAdditional information that cannot be captured in the structured elements and/or any other specific block.\n" + } + ] + } + }, + "required": [ + "Assgnmt", + "Rpt" + ], + "example": { + "Assgnmt": { + "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" + } + } + } + } + } + }, + "VerificationReport4b": { + "title": "VerificationReport4", + "type": "object", + "description": "VerificationReport\nProvides information about the verification of party and/or account identification information.", + "properties": { + "OrgnlId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "OriginalIdentification\nUnique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message.\n" + } + ] + }, + "Vrfctn": { + "allOf": [ + { + "title": "IdentificationVerificationIndicator", + "type": "boolean", + "example": true, + "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n" + }, + { + "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n" + } + ] + }, + "Rsn": { + "allOf": [ + { + "title": "VerificationReason1Choice", + "type": "object", + "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalVerificationReason1Code", + "description": "Specifies the external verification reason code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + { + "description": "Reason\nSpecifies the reason why the verified identification information is incorrect.\n" + } + ] + }, + "OrgnlPtyAndAcctId": { + "allOf": [ + { + "title": "IdentificationInformation4", + "type": "object", + "description": "Information that locates and identifies a specific party or account.\n", + "properties": { + "Pty": { + "allOf": [ + { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "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", @@ -31508,14 +30427,6 @@ "Cd": "ADDR" } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", @@ -31533,12 +30444,12 @@ "example": 1.2345678901234567e+99 }, "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", @@ -31549,12 +30460,12 @@ "example": 1234567890123456 }, "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", @@ -31564,14 +30475,6 @@ "maxLength": 70, "example": 1.2345678901234567e+99 }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", @@ -31597,28 +30500,28 @@ "example": 1234567890123456 }, "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", @@ -31646,14 +30549,12 @@ }, "example": { "AdrTp": "ADDR", - "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", - "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", @@ -31669,561 +30570,689 @@ "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": [ + "Id": { + "allOf": [ + { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "anyOf": [ { - "title": "GenericAccountIdentification1", - "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { - "Id": { - "allOf": [ - { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 - }, - { - "description": "Identification\nIdentification assigned by an institution.\n" - } - ] - }, - "SchmeNm": { + "OrgId": { "allOf": [ { - "title": "AccountSchemeName1Choice", + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - { - "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" - } - ] - }, - "Prxy": { - "allOf": [ - { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", - "type": "object", - "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": "GenericOrganisationIdentification1", + "type": "object", + "description": "Information that locates and identifies an organisation.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + } + ] + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } }, { - "description": "Code\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": "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": "Proprietary\nProxy account type, in a proprietary form.\n" + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ - "Prtry" + "PrvtId" ] } ], "example": { - "Cd": "EMAIL" + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } } }, { - "description": "Type\nType of the proxy identification.\n" + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, - "Id": { + "CtryOfRes": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "title": "CountryCode", "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\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" } ] } @@ -32232,614 +31261,276 @@ "Id" ], "example": { - "Tp": { - "Cd": "IBAN" + "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": 123 + "Id": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Prtry": "DfspId" + } + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } } }, { - "description": "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": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, - "InstrInf": { + "Acct": { "allOf": [ { - "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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", - "type": "string", - "pattern": "^[A-Za-z0-9-_]{43}$", - "maxLength": 48 - }, - { - "description": "SHA-256 signature of the terms\n" - } - ] - } - }, - "required": [ - "Sh256Sgntr" - ] - } - ], - "example": { - "IlpV4PrepPacket": "1234567890ABCDEF" - } - }, - { - "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" - } - ] - } - }, - "required": [ - "PmtId", - "IntrBkSttlmAmt", - "Dbtr", - "Cdtr" - ], - "example": { - "PmtId": { - "InstrId": "INSTRID", - "EndToEndId": "ENDTOENDID" - }, - "PmtTpInf": { - "LclInstrm": { - "Cd": "CHQB", - "Prtry": "PROPRIETARY" - } - }, - "IntrBkSttlmAmt": { - "Amount": 123.45, - "Ccy": "EUR" - }, - "Dbtr": { - "Nm": "Debtor Name" - }, - "DbtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "DbtrAgt": { - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "CdtrAgt": { - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "Cdtr": { - "Nm": "Creditor Name" - }, - "CdtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "InstrForCdtrAgt": { - "Cd": "INSTRUCTION" - }, - "Purp": { - "Cd": "CHAR" - }, - "VrfctnOfTerms": { - "Cntt": "CONTENT", - "CnttTp": "PROPRIETARY" - } - } - }, - "CreditTransferTransaction68_FX_Quotes": { - "title": "CreditTransferTransaction68_FX_Quotes", - "description": "Provides further details specific to the individual transaction(s) included in the message.\n", - "type": "object", - "properties": { - "PmtId": { - "allOf": [ - { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", - "type": "object", - "properties": { - "InstrId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" - }, - { - "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" - } - ] - }, - "ClrSysRef": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" - } - ] - } - }, - "required": [ - "TxId" - ], - "example": { - "InstrId": "INSTRUCTIONID", - "EndToEndId": "ENDTOENDID", - "TxId": "TRANSACTIONID", - "UETR": "123e4567-e89b-12d3-a456-426614174000", - "ClrSysRef": "CLRSYSREF" - } - }, - { - "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" - } - ] - }, - "PmtTpInf": { - "allOf": [ - { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", - "type": "object", - "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", + "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": [ { - "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", - "maxLength": 4, - "minLength": 1, - "type": "string", - "example": 1234 + "properties": { + "IBAN": { + "allOf": [ + { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "example": "FR1420041010050500013M02606", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" + }, + { + "description": "IBAN\nInternational Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions.\n" + } + ] + } + }, + "required": [ + "IBAN" + ] }, { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "properties": { + "Othr": { + "allOf": [ + { + "title": "GenericAccountIdentification1", + "type": "object", + "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + { + "description": "Identification\nIdentification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + } + ] + } + }, + "required": [ + "Othr" + ] } - ] + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + { + "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "Tp": { + "allOf": [ + { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "anyOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nAccount type, in a coded form.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, { - "description": "Proprietary\nCategory purpose, in a proprietary form.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - ] - } - }, - "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})$" + ], + "example": { + "Cd": "CACC" + } }, { - "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, @@ -33020,103 +31711,1198 @@ ] }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "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" } ] } }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } } }, { - "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": "Account\nUnambiguous identification of the account of a party.\n" } ] }, - "Dbtr": { + "Agt": { "allOf": [ { - "title": "PartyIdentification272", - "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": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" - } - ] - }, - "PstlAdr": { + "FinInstnId": { "allOf": [ { - "title": "PostalAddress27", + "title": "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": [ + { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + } + ] + }, + "ClrSysMmbId": { + "allOf": [ { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", "properties": { - "Cd": { + "ClrSysId": { "allOf": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + { + "description": "Code\nClearing system identification code, as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nProprietary identification of the clearing system.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } ], + "example": { + "Cd": "CHIPS" + } + }, + { + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + } + ] + }, + "MmbId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "example": "ADDR" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "Cd" - ] + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identifier of the financial institution.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericFinancialIdentification1", + "type": "object", + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + } + ] + } + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 + }, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 + } + } + }, + { + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" + } + ] + }, + "BrnchId": { + "allOf": [ + { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + }, + { + "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Agent\nFinancial institution servicing an account for a party.\n" + } + ] + } + }, + "required": [ + "Pty" + ], + "example": { + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" + }, + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } + } + } + }, + { + "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n" + } + ] + }, + "UpdtdPtyAndAcctId": { + "allOf": [ + { + "title": "IdentificationInformation4", + "type": "object", + "description": "Information that locates and identifies a specific party or account.\n", + "properties": { + "Pty": { + "allOf": [ + { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 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" @@ -33179,14 +32965,6 @@ "Cd": "ADDR" } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", @@ -33204,12 +32982,12 @@ "example": 1.2345678901234567e+99 }, "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", @@ -33220,12 +32998,12 @@ "example": 1234567890123456 }, "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", @@ -33235,14 +33013,6 @@ "maxLength": 70, "example": 1.2345678901234567e+99 }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", @@ -33268,28 +33038,28 @@ "example": 1234567890123456 }, "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", @@ -33317,14 +33087,12 @@ }, "example": { "AdrTp": "ADDR", - "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", - "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", @@ -33337,15 +33105,15 @@ } }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", + "title": "Party38Choice", + "description": "Nature or use of the account.\n", "type": "object", "anyOf": [ { @@ -33353,7 +33121,7 @@ "OrgId": { "allOf": [ { - "title": "OrganisationIdentification39", + "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "properties": { @@ -33388,22 +33156,22 @@ "Othr": { "allOf": [ { - "title": "GenericOrganisationIdentification3", + "title": "GenericOrganisationIdentification1", "type": "object", - "description": "Information related to an identification of an organisation.\n", + "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 256, - "example": 256 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, @@ -33526,7 +33294,7 @@ "PrvtId": { "allOf": [ { - "title": "PersonIdentification18", + "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "properties": { @@ -33616,20 +33384,20 @@ "Othr": { "allOf": [ { - "title": "GenericPersonIdentification2", + "title": "GenericPersonIdentification1", "type": "object", - "description": "Identification of a person.", + "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 256, - "example": 256 - }, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } @@ -33744,7 +33512,7 @@ } }, { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } @@ -33767,7 +33535,7 @@ } }, { - "description": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, @@ -33781,14 +33549,14 @@ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { - "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" + "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" } ] }, "CtctDtls": { "allOf": [ { - "title": "Contact13", + "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "properties": { @@ -33807,7 +33575,7 @@ "example": "DOCT" }, { - "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" + "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, @@ -33865,7 +33633,7 @@ } ] }, - "URLAdr": { + "EmailAdr": { "allOf": [ { "title": "Max2048Text", @@ -33875,21 +33643,6 @@ "maxLength": 2048, "example": 2048 }, - { - "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" - } - ] - }, - "EmailAdr": { - "allOf": [ - { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 - }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } @@ -34002,15 +33755,15 @@ } }, { - "description": "OtherContact\nContact details in another form.\n" + "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { - "title": "PreferredContactMethod2Code", - "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", @@ -34019,10 +33772,10 @@ "FAXX", "CELL" ], - "example": "MAIL" + "example": "CELL" }, { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } @@ -34033,12 +33786,11 @@ "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", - "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } @@ -34054,19 +33806,25 @@ "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry" + "Ctry": "Ctry", + "AdrLine": "AdrLine" }, "Id": { "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "Othr": { + "Id": 123, + "SchmeNm": { + "Prtry": "DfspId" + } } } }, @@ -34082,1068 +33840,564 @@ } }, { - "description": "Party that owes an amount of money to the (ultimate) creditor.\n" + "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, - "Cdtr": { + "Acct": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "CashAccount40", "type": "object", + "description": "Provides the details to identify an account.\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", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "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", + "title": "AccountIdentification4Choice", "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { - "OrgId": { + "IBAN": { "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": "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": "Organisation\nUnique and unambiguous way to identify an organisation.\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": [ - "OrgId" + "IBAN" ] }, { "properties": { - "PrvtId": { + "Othr": { "allOf": [ { - "title": "PersonIdentification18", - "description": "Unique and unambiguous way to identify a person.\n", + "title": "GenericAccountIdentification1", "type": "object", + "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\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": "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": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + "description": "Identification\nIdentification assigned by an institution.\n" } ] }, - "Othr": { + "SchmeNm": { "allOf": [ { - "title": "GenericPersonIdentification2", + "title": "AccountSchemeName1Choice", "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": [ + "description": "Sets of elements to identify a name of the identification scheme.\n", + "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": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } - ], - "example": { - "Cd": "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": 1111 } }, { - "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": "IBAN" }, - "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 an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ - "PrvtId" + "Othr" ] } ], "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } + "IBAN": "BE71096123456769" } }, { - "description": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, - "CtryOfRes": { + "Tp": { "allOf": [ { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, 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": "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": "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": "Type\nSpecifies the nature, or use of the account.\n" } ] }, - "CtctDtls": { + "Ccy": { "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": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\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" + "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" ] }, - "Id": { - "allOf": [ - { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 128, - "example": 12345 - }, - { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nProxy account type, in a proprietary form.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "ChanlTp" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Cd": "EMAIL" } }, { - "description": "OtherContact\nContact details in another form.\n" + "description": "Type\nType of the proxy identification.\n" } ] }, - "PrefrdMtd": { + "Id": { "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": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "MAIL" + "minLength": 1, + "maxLength": 2048, + "example": 2048 }, { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "URLAdr": "http://www.example.com", - "EmailAdr": "example@example.com" + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\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" - } - } + "IBAN": "BE71096123456769" }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 } } }, { - "description": "Party to which an amount of money is due.\n" + "description": "Account\nUnambiguous identification of the account of a party.\n" } ] }, - "DbtrAgt": { + "Agt": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "FinancialInstitutionIdentification18", "type": "object", "description": "Information used to identify a financial institution.\n", "properties": { @@ -35157,7 +34411,7 @@ "example": "J5BMVH7D" }, { - "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, @@ -35699,16 +34953,16 @@ } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "BranchData3", "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ @@ -35735,7 +34989,7 @@ "example": "529900T8BM49AURSDO55" }, { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" + "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, @@ -35757,7 +35011,7 @@ "PstlAdr": { "allOf": [ { - "title": "PostalAddress27", + "title": "PostalAddress24", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -35872,14 +35126,6 @@ "Cd": "ADDR" } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", @@ -35897,12 +35143,12 @@ "example": 1.2345678901234567e+99 }, "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", @@ -35913,12 +35159,12 @@ "example": 1234567890123456 }, "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", @@ -35928,14 +35174,6 @@ "maxLength": 70, "example": 1.2345678901234567e+99 }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", @@ -35961,28 +35199,28 @@ "example": 1234567890123456 }, "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", @@ -36010,14 +35248,12 @@ }, "example": { "AdrTp": "ADDR", - "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", - "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", @@ -36030,26 +35266,30 @@ } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, - "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", - "BldgNb": "Building number" + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" } } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } @@ -36080,66 +35320,201 @@ } }, { - "description": "Financial institution servicing an account for the debtor.\n" + "description": "Agent\nFinancial institution servicing an account for a party.\n" } ] + } + }, + "required": [ + "Pty" + ], + "example": { + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" }, - "CdtrAgt": { + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } + } + } + }, + { + "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n" + } + ] + } + }, + "required": [ + "OrgnlId", + "Vrfctn", + "Rsn" + ], + "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" + } + } + } + } + } + }, + "GetPartiesError_IdentificationVerificationReportV03": { + "title": "GetPartiesError_IdentificationVerificationReportV03", + "type": "object", + "properties": { + "Assgnmt": { + "allOf": [ + { + "title": "IdentificationAssignment3", + "type": "object", + "description": "IdentificationAssignment\nInformation that unambiguously identifies a message, as assigned by the assignor to the assignee.\n", + "properties": { + "MsgId": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "Max35Text", + "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", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "description": "Information used to identify a financial institution.\n", - "properties": { - "BICFI": { - "allOf": [ - { - "title": "BICFIDec2014Identifier", - "type": "string", - "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" + "anyOf": [ + { + "properties": { + "Pty": { + "allOf": [ + { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] }, - { - "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" - } - ] - }, - "ClrSysMmbId": { - "allOf": [ - { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", + "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "example": "ADDR" }, { - "description": "Code\nClearing system identification code, as published in an external list.\n" + "description": "Code\nType of address expressed as a code.\n" } ] } @@ -36153,15 +35528,67 @@ "Prtry": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } @@ -36172,17 +35599,42 @@ } ], "example": { - "Cd": "CHIPS" + "Cd": "ADDR" } }, - { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" - } - ] - }, - "MmbId": { - "allOf": [ - { + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -36190,1144 +35642,1430 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] - } - }, - "required": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } }, - "MmbId": 123456789 - } - }, - { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" - }, - { - "description": "LEI\nLegal entity identifier of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "Id": { + "allOf": [ + { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", "type": "object", - "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { - "Cd": { + "OrgId": { "allOf": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "allOf": [ + { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "AnyBIC\nBusiness identification code of the organisation.\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericOrganisationIdentification1", + "type": "object", + "description": "Information that locates and identifies an organisation.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + } + ] + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ - "Cd" + "OrgId" ] }, { "properties": { - "Prtry": { + "PrvtId": { "allOf": [ { - "title": "GenericIdentification30", + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", "type": "object", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "BirthDate\nDate on which a person was born.\n" + } + ] + }, + "PrvcOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ProvinceOfBirth\nProvince where a person was born.\n" + } + ] + }, + "CityOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "CityOfBirth\nCity where a person was born.\n" + } + ] + }, + "CtryOfBirth": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "CountryOfBirth\nCountry where a person was born.\n" + } + ] + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, - "SchmeNm": { + "Othr": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "GenericPersonIdentification1", + "type": "object", + "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Id", - "Issr" - ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ - "Prtry" + "PrvtId" ] } ], "example": { - "Cd": "ADDR" + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + { + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" + } + ] + }, + "CtryOfRes": { + "allOf": [ + { + "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" }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } + ] }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] - }, - "Othr": { - "allOf": [ - { - "title": "GenericFinancialIdentification1", - "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "CtctDtls": { + "allOf": [ + { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "allOf": [ + { + "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + { + "description": "NamePrefix\nName prefix to be used before the name of the person.\n" + } + ] }, - { - "description": "Identification\nUnique and unambiguous identification of a person.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "anyOf": [ + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PhneNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + } + ] + }, + "MobNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + } + ] + }, + "FaxNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + } + ] + }, + "EmailAdr": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + { + "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" + } + ] + }, + "EmailPurp": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + } + ] + }, + "JobTitl": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "JobTitle\nTitle of the function.\n" + } + ] + }, + "Rspnsblty": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Responsibility\nRole of a person in an organisation.\n" + } + ] + }, + "Dept": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Department\nIdentification of a division of a large organisation or building.\n" + } + ] + }, + "Othr": { + "allOf": [ { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", "properties": { - "Cd": { + "ChanlTp": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 128, + "example": 12345 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Prtry" - ] + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + { + "description": "Other\nContact details in another form.\n" } - ], - "example": { - "Cd": "BIC" - } + ] }, - { - "description": "SchemeName\nName of the identification scheme.\n" + "PrefrdMtd": { + "allOf": [ + { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + }, + { + "description": "PreferredMethod\nPreferred method used to reach the contact.\n" + } + ] } - ] + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] + { + "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + }, + "Id": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Prtry": "DfspId" + } } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" } }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" } - ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 - }, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" + } }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + { + "description": "Party\nIdentification of a person or an organisation.\n" } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + ] } + }, + "required": [ + "Pty" ] }, - "BrnchId": { - "allOf": [ - { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "type": "object", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" - }, - { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress27", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + { + "properties": { + "Agt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification18", "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] + "description": "Information used to identify a financial institution.\n", + "properties": { + "BICFI": { + "allOf": [ + { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ + "ClrSysMmbId": { + "allOf": [ + { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + { + "description": "Code\nClearing system identification code, as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" + } + ] + }, + "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" ] }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Id", - "Issr" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Cd": "ADDR" } }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "ADDR" - } - }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] - } - }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } - } - }, - { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" - } - ] - } - }, - "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - } - }, - { - "description": "Financial institution servicing an account for the creditor.\n" - } - ] - } - }, - "required": [ - "Dbtr", - "Cdtr", - "DbtrAgt", - "CdtrAgt" - ] - }, - { - "description": "Underlying Customer Credit Transfer\nTBD\n" - } - ] - }, - "IntrBkSttlmAmt": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount_SimpleType", - "type": "string", - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", - "example": 123.45 - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" - } - ] - }, - "Dbtr": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "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": { + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "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": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", - "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "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": "Code\nClearing system identification code, as published in an external list.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Cd" - ] + "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": { - "Prtry": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -37338,150 +37076,190 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\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", + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-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", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -37489,14 +37267,39 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -37504,449 +37307,15 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "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", + "TwnLctnNm": { + "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" - } - ] - }, - "Issr": { - "allOf": [ - { + "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -37954,14 +37323,7 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { + "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -37969,1264 +37331,979 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "SchemeName\nShort textual description of the scheme.\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": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\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": [ - "Prtry" ] } + }, + "required": [ + "FinInstnId" ], "example": { - "Cd": "ADDR" + "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" + } + } } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "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": "Agent\nIdentification of a financial institution.\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": [ + "Agt" ] } - }, + ], "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" + "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": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\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": { + "Assgne": { "allOf": [ { - "title": "AccountIdentification4Choice", + "title": "Party40Choice", + "description": "Identification of a person, an organisation or a financial institution.\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": { + "Pty": { "allOf": [ { - "title": "GenericAccountIdentification1", + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { - "Id": { + "Nm": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 + "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": "AccountSchemeName1Choice", + "title": "PostalAddress24", "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": "Information that locates and identifies a 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": 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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - { - "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" - } - ] - }, - "Prxy": { - "allOf": [ - { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", - "type": "object", - "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" ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "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" + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "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": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { + "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": "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } + "OrgId" + ] }, { - "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 + "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" + } + ] }, - { - "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": [ + "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": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification 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\nName of the identification scheme, in a coded form as published in an external 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", @@ -39237,542 +38314,26 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "EmailPurpose\nPurpose for which an email address may be used.\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": { + "JobTitl": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 5, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nClearing system identification code, as published in an external list.\n" + "description": "JobTitle\nTitle of the function.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Rspnsblty": { "allOf": [ { "title": "Max35Text", @@ -39783,615 +38344,475 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "Responsibility\nRole of a person in an organisation.\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" - } - ] + "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 }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + { + "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": "Issuer\nEntity that assigns the identification.\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 + } }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum 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\nContact details in another form.\n" } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } + ] }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "PrefrdMtd": { + "allOf": [ + { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + }, + { + "description": "PreferredMethod\nPreferred method used to reach the contact.\n" + } + ] } - ] + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + }, + { + "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } - }, - "required": [ - "Prtry" ] } + }, + "required": [ + "Id" ], "example": { - "Cd": "ADDR" + "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" + } } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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": "Party\nIdentification of a person or an organisation.\n" } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + ] } + }, + "required": [ + "Pty" ] }, - "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": { + "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": { - "Cd": { + "BICFI": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification 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\nName of the identification scheme, in a coded form as published in an external 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", + "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": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\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", + "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", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -40399,14 +38820,39 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -40414,2568 +38860,2917 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + }, + "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 }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } + "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" + } + ] }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-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": [ - "Prtry" ] } + }, + "required": [ + "FinInstnId" ], "example": { - "Cd": "ADDR" + "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" + } + } } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "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": "Agent\nIdentification of a financial institution.\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": [ + "Agt" ] } - }, + ], "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" + "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": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Assignee\nParty that the identification assignment is assigned to. This is also the receiver of the message.\n" } ] } }, "required": [ - "FinInstnId" + "MsgId", + "CreDtTm", + "Assgnr", + "Assgne" ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "MsgId": 123, + "CreDtTm": "2020-01-01T00:00:00Z", + "Assgnr": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } }, - "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" + "Assgne": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } } } } }, { - "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" + "description": "Assignment\nInformation related to the identification assignment.\n" } ] }, - "Cdtr": { + "Rpt": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "VerificationReport4", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "description": "VerificationReport\nProvides information about the verification of party and/or account identification information.", "properties": { - "FinInstnId": { + "OrgnlId": { "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": "OriginalIdentification\nUnique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message.\n" + } + ] + }, + "Vrfctn": { + "allOf": [ + { + "title": "IdentificationVerificationIndicator", + "type": "boolean", + "example": true, + "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n" + }, + { + "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n" + } + ] + }, + "Rsn": { + "allOf": [ + { + "title": "VerificationReason1Choice", "type": "object", - "description": "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": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalVerificationReason1Code", + "description": "Specifies the external verification reason code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n" + } + ] } + }, + "required": [ + "Cd" ] }, - "ClrSysMmbId": { + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + { + "description": "Reason\nSpecifies the reason why the verified identification information is incorrect.\n" + } + ] + }, + "OrgnlPtyAndAcctId": { + "allOf": [ + { + "title": "IdentificationInformation4", + "type": "object", + "description": "Information that locates and identifies a specific party or account.\n", + "properties": { + "Pty": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "properties": { - "ClrSysId": { + "Nm": { "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": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, - "MmbId": { + "PstlAdr": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "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" - ] - }, - { + "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": { - "Cd": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "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 + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "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 person.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "SchmeNm": { + "Id": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "Party38Choice", + "description": "Nature or use of the account.\n", "type": "object", - "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { - "Cd": { + "OrgId": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "allOf": [ + { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "AnyBIC\nBusiness identification code of the organisation.\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericOrganisationIdentification1", + "type": "object", + "description": "Information that locates and identifies an organisation.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + } + ] + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } }, { - "description": "Code\nName of the identification scheme, 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": "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": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ - "Prtry" + "PrvtId" ] } ], "example": { - "Cd": "BIC" + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } } }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, - "Issr": { + "CtryOfRes": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "CountryCode", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { - "description": "Issuer\nEntity that assigns the identification.\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": [ - "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": [ + "CtctDtls": { + "allOf": [ { + "title": "Contact4", + "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\nName prefix to be used before the name of the person.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Nm": { "allOf": [ { - "title": "GenericIdentification30", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 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", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { + "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": "Issuer\nEntity that assigns the identification.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "SchmeNm": { + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Id", - "Issr" + "ChanlTp" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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": "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": [ + "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", + "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": "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": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\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": [ + "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": "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": { + "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": "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 + "properties": { + "Othr": { + "allOf": [ + { + "title": "GenericAccountIdentification1", + "type": "object", + "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + { + "description": "Identification\nIdentification assigned by an institution.\n" + } + ] }, - { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "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": "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" + } + ] }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] } - ] + }, + "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": [ - "Prtry" ] } - ], - "example": { - "Cd": 1111 - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" + }, + "required": [ + "Othr" + ] } - ] + ], + "example": { + "IBAN": "BE71096123456769" + } }, - "Issr": { - "allOf": [ + { + "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": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nAccount type, in a coded form.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, { - "description": "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\nNature or use of the account in a proprietary form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + ], + "example": { + "Cd": "CACC" + } }, - "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": "Type\nSpecifies the nature, or use of the account.\n" + } + ] }, - { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "CACC" - } - }, - { - "description": "Type\nSpecifies the nature, or use of the account.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - { - "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" - } - ] - }, - "Prxy": { - "allOf": [ - { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", - "type": "object", - "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" - } + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "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": "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" + } + ] }, - { - "description": "Proprietary\nProxy account type, in a proprietary form.\n" + "Id": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + { + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + } + ] } - ] + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + }, + { + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "EMAIL" + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } } }, { - "description": "Type\nType of the proxy identification.\n" + "description": "Account\nUnambiguous identification of the account of a party.\n" } ] }, - "Id": { + "Agt": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 - }, - { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Tp": { - "Cd": "IBAN" - }, - "Id": 123 - } - }, - { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" - } - ] - } - }, - "example": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" - }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 - } - } - }, - { - "description": "CreditorAccount\nAccount to which a credit entry is made.\n" - } - ] - }, - "InstrForCdtrAgt": { - "allOf": [ - { - "title": "InstructionForCreditorAgent3_Put_FX_Quotes_ID", - "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", - "type": "object", - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalCreditorAgentInstruction1Code", - "description": "Specifies the instruction given by the creditor to the creditor agent.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" - } - ] - }, - "InstrInf": { - "allOf": [ - { - "title": "AmountTypeEnum", - "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", - "type": "string", - "enum": [ - "SEND", - "RECEIVE" - ], - "example": "SEND" - }, - { - "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" - } - ] - } - }, - "example": { - "Cd": "PHOA", - "InstrInf": "Please advise/contact next agent by phone." - } - }, - { - "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" - } - ] - }, - "Purp": { - "allOf": [ - { - "title": "Purpose2Choice", - "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", - "type": "object", - "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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", - "type": "string", - "pattern": "^[A-Za-z0-9-_]{43}$", - "maxLength": 48 - }, - { - "description": "SHA-256 signature of the terms\n" - } - ] - } - }, - "required": [ - "Sh256Sgntr" - ] - } - ], - "example": { - "IlpV4PrepPacket": "1234567890ABCDEF" - } - }, - { - "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" - } - ] - } - }, - "required": [ - "PmtId", - "IntrBkSttlmAmt", - "Dbtr", - "Cdtr" - ], - "example": { - "PmtId": { - "InstrId": "INSTRID", - "EndToEndId": "ENDTOENDID" - }, - "PmtTpInf": { - "LclInstrm": { - "Cd": "CHQB", - "Prtry": "PROPRIETARY" - } - }, - "IntrBkSttlmAmt": { - "Amount": 123.45, - "Ccy": "EUR" - }, - "Dbtr": { - "Nm": "Debtor Name" - }, - "DbtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "DbtrAgt": { - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "CdtrAgt": { - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "Cdtr": { - "Nm": "Creditor Name" - }, - "CdtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "InstrForCdtrAgt": { - "Cd": "INSTRUCTION" - }, - "Purp": { - "Cd": "CHAR" - }, - "VrfctnOfTerms": { - "Cntt": "CONTENT", - "CnttTp": "PROPRIETARY" - } - } - }, - "CryptographicLockChoice": { - "title": "CryptographicLockChoice", - "description": "Cryptographically signed terms\n", - "type": "object", - "anyOf": [ - { - "properties": { - "IlpV4PrepPacket": { - "allOf": [ - { - "title": "hexBinary", - "type": "string", - "example": 4660, - "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" - }, - { - "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" - } - ] - } - }, - "required": [ - "IlpV4PrepPacket" - ] - }, - { - "properties": { - "Sh256Sgntr": { - "allOf": [ - { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", - "type": "string", - "pattern": "^[A-Za-z0-9-_]{43}$", - "maxLength": 48 - }, - { - "description": "SHA-256 signature of the terms\n" - } - ] - } - }, - "required": [ - "Sh256Sgntr" - ] - } - ], - "example": { - "IlpV4PrepPacket": "1234567890ABCDEF" - } - }, - "DateAndDateTime2Choice": { - "title": "StatusReason6Choice", - "description": "Specifies the reason for the status.\n", - "type": "object", - "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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", - "type": "string", - "pattern": "^[A-Za-z0-9-_]{43}$", - "maxLength": 48 - }, - "Exact4AlphaNumericText": { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - "Execute_FIToFICustomerCreditTransferV13": { - "title": "Execute_FIToFICustomerCreditTransferV13", - "type": "object", - "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": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "Cd": { + "BICFI": { "allOf": [ { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", + "title": "BICFIDec2014Identifier", "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" }, { - "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" + "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "ClrSysMmbId": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + { + "description": "Code\nClearing system identification code, as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nProprietary identification of the clearing system.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHIPS" + } + }, + { + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + } + ] + }, + "MmbId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + } + ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + { + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "SEPA" - } - }, - { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" - } - ] - }, - "LclInstrm": { - "allOf": [ - { - "title": "LocalInstrument2Choice", - "type": "object", - "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", - "anyOf": [ - { - "properties": { - "Cd": { + }, + "Nm": { "allOf": [ { - "title": "ExternalLocalInstrument1Code", - "description": "Specifies the external local instrument identification code.", + "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" + "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" - ] + "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": { - "Prtry": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -42986,739 +41781,398 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\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": { + }, + "LEI": { "allOf": [ { - "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", - "maxLength": 4, - "minLength": 1, + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a 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": 1234 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "description": "Legal Entity Identifier\nLegal entity identification for the branch 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\nCategory purpose, in a proprietary form.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\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": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" - }, - { - "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" - } - ] - }, - "ClrSysRef": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" - } - ] - } - }, - "required": [ - "TxId" - ], - "example": { - "InstrId": "INSTRUCTIONID", - "EndToEndId": "ENDTOENDID", - "TxId": "TRANSACTIONID", - "UETR": "123e4567-e89b-12d3-a456-426614174000", - "ClrSysRef": "CLRSYSREF" - } - }, - { - "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" - } - ] - }, - "PmtTpInf": { - "allOf": [ - { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", - "type": "object", - "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" + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" + }, + "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": [ - "Prtry" ] } + }, + "required": [ + "FinInstnId" ], "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" - ] + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nCategory purpose, in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } } - ], - "example": { - "Cd": "CASH" } }, { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "description": "Agent\nFinancial institution servicing an account for a party.\n" } ] } }, + "required": [ + "Pty" + ], "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" }, - "LclInstrm": { - "Cd": "CORE" + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } }, - "CtgyPurp": { - "Cd": "CASH" + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } } } }, { - "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" + "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n" } ] }, - "UndrlygCstmrCdtTrf": { + "UpdtdPtyAndAcctId": { "allOf": [ { - "title": "UnderlyingCustomerCreditTransfer", + "title": "IdentificationInformation4", "type": "object", + "description": "Information that locates and identifies a specific party or account.\n", "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" - } - ] - }, - "Dbtr": { + "Pty": { "allOf": [ { - "title": "PartyIdentification272", + "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "properties": { @@ -43740,7 +42194,7 @@ "PstlAdr": { "allOf": [ { - "title": "PostalAddress27", + "title": "PostalAddress24", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -43855,14 +42309,6 @@ "Cd": "ADDR" } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", @@ -43880,12 +42326,12 @@ "example": 1.2345678901234567e+99 }, "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", @@ -43896,12 +42342,12 @@ "example": 1234567890123456 }, "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", @@ -43911,14 +42357,6 @@ "maxLength": 70, "example": 1.2345678901234567e+99 }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", @@ -43944,28 +42382,28 @@ "example": 1234567890123456 }, "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", @@ -43993,14 +42431,12 @@ }, "example": { "AdrTp": "ADDR", - "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", - "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", @@ -44013,15 +42449,15 @@ } }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", + "title": "Party38Choice", + "description": "Nature or use of the account.\n", "type": "object", "anyOf": [ { @@ -44029,7 +42465,7 @@ "OrgId": { "allOf": [ { - "title": "OrganisationIdentification39", + "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "properties": { @@ -44064,22 +42500,22 @@ "Othr": { "allOf": [ { - "title": "GenericOrganisationIdentification3", + "title": "GenericOrganisationIdentification1", "type": "object", - "description": "Information related to an identification of an organisation.\n", + "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 256, - "example": 256 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, @@ -44202,7 +42638,7 @@ "PrvtId": { "allOf": [ { - "title": "PersonIdentification18", + "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "properties": { @@ -44292,19 +42728,19 @@ "Othr": { "allOf": [ { - "title": "GenericPersonIdentification2", + "title": "GenericPersonIdentification1", "type": "object", - "description": "Identification of a person.", + "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 256, - "example": 256 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" @@ -44420,7 +42856,7 @@ } }, { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } @@ -44443,7 +42879,7 @@ } }, { - "description": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, @@ -44457,14 +42893,14 @@ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { - "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" + "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" } ] }, "CtctDtls": { "allOf": [ { - "title": "Contact13", + "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "properties": { @@ -44483,7 +42919,7 @@ "example": "DOCT" }, { - "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" + "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, @@ -44541,7 +42977,7 @@ } ] }, - "URLAdr": { + "EmailAdr": { "allOf": [ { "title": "Max2048Text", @@ -44551,21 +42987,6 @@ "maxLength": 2048, "example": 2048 }, - { - "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" - } - ] - }, - "EmailAdr": { - "allOf": [ - { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 - }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } @@ -44678,15 +43099,15 @@ } }, { - "description": "OtherContact\nContact details in another form.\n" + "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { - "title": "PreferredContactMethod2Code", - "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", @@ -44695,10 +43116,10 @@ "FAXX", "CELL" ], - "example": "MAIL" + "example": "CELL" }, { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } @@ -44709,12 +43130,11 @@ "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", - "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } @@ -44730,19 +43150,25 @@ "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry" + "Ctry": "Ctry", + "AdrLine": "AdrLine" }, "Id": { "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "Othr": { + "Id": 123, + "SchmeNm": { + "Prtry": "DfspId" + } } } }, @@ -44758,837 +43184,503 @@ } }, { - "description": "Party that owes an amount of money to the (ultimate) creditor.\n" + "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, - "Cdtr": { + "Acct": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "CashAccount40", "type": "object", + "description": "Provides the details to identify an account.\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": { + "Id": { "allOf": [ { - "title": "PostalAddress27", + "title": "AccountIdentification4Choice", "type": "object", - "description": "Information that locates and identifies a 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": "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": [ - "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" + }, + "required": [ + "IBAN" + ] }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies 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": { + "Othr": { "allOf": [ { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", + "title": "GenericAccountIdentification1", "type": "object", + "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\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": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 }, { - "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": "AccountSchemeName1Choice", "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": [ + "description": "Sets of elements to identify a name of the identification scheme.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ { - "properties": { - "Cd": {} - } + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "properties": { - "Prtry": {} - } + "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" + ] } + }, + "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": "BIC" - }, - "Issr": "BIC" + "Cd": 1111 } }, { - "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": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ - "OrgId" + "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": { - "PrvtId": { + "Prtry": { "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 - } - } - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ - "PrvtId" + "Prtry" ] } ], "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } + "Cd": "CACC" } }, { - "description": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, - "CtryOfRes": { + "Ccy": { "allOf": [ { - "title": "CountryCode", + "title": "ActiveOrHistoricCurrencyCode", "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\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" } ] }, - "CtctDtls": { + "Nm": { "allOf": [ { - "title": "Contact13", - "description": "Specifies the details of the contact person.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", "type": "object", "properties": { - "NmPrfx": { + "Tp": { "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": "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" + ] + } ], - "type": "string", - "example": "DOCT" + "example": { + "Cd": "EMAIL" + } }, { - "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" + "description": "Type\nType of the proxy identification.\n" } ] }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 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": { + "Id": { "allOf": [ { "title": "Max2048Text", @@ -45599,227 +43691,57 @@ "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" + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "URLAdr": "http://www.example.com", - "EmailAdr": "example@example.com" + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\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" - } - } + "IBAN": "BE71096123456769" }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 } } }, { - "description": "Party to which an amount of money is due.\n" + "description": "Account\nUnambiguous identification of the account of a party.\n" } ] }, - "DbtrAgt": { + "Agt": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "FinancialInstitutionIdentification18", "type": "object", "description": "Information used to identify a financial institution.\n", "properties": { @@ -45833,7 +43755,7 @@ "example": "J5BMVH7D" }, { - "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, @@ -46375,16 +44297,16 @@ } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "BranchData3", "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ @@ -46411,7 +44333,7 @@ "example": "529900T8BM49AURSDO55" }, { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" + "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, @@ -46430,492 +44352,6 @@ } ] }, - "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": [ { @@ -47174,134 +44610,13 @@ } }, { - "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" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, - "required": [], "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 - }, - "LEI": 123, + "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", @@ -47314,369 +44629,11 @@ "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" + "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" } ] } @@ -47707,2944 +44664,3156 @@ } }, { - "description": "Financial institution servicing an account for the creditor.\n" + "description": "Agent\nFinancial institution servicing an account for a party.\n" } ] } }, "required": [ - "Dbtr", - "Cdtr", - "DbtrAgt", - "CdtrAgt" - ] + "Pty" + ], + "example": { + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" + }, + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } + } + } }, { - "description": "Underlying Customer Credit Transfer\nTBD\n" + "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\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", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" + } + }, + "required": [ + "OrgnlId", + "Vrfctn", + "Rsn" + ], + "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" } - }, - { - "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" } - ] + } }, - "InstdAmt": { + "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": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveOrHistoricCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", - "type": "string", - "example": 123.45, - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" - }, - { - "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "title": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 350, + "example": 350 }, { - "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": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" } ] }, - "XchgRate": { + "Envlp": { "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})$" + "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": "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": "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" } ] - }, - "ChrgBr": { - "title": "ChargeBearerType1Code", - "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", + } + }, + "required": [ + "Envlp" + ], + "example": { + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } + } + }, + { + "description": "SupplementaryData\nAdditional information that cannot be captured in the structured elements and/or any other specific block.\n" + } + ] + } + }, + "required": [ + "Assgnmt", + "Rpt" + ], + "example": { + "Assgnmt": { + "Id": 123, + "CreDtTm": "2013-03-07T16:30:00", + "Assgnr": { + "Id": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + "Assgne": { + "Id": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "Rpt": { + "Id": 123, + "CreDtTm": "2013-03-07T16:30:00", + "RptgPty": { + "Id": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + "RptdPty": { + "Id": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + "RptdDoc": { + "Nb": 123, + "RltdDt": "2013-03-07", + "RltdDtTp": { + "Cd": 123 + } + }, + "Rsn": { + "Cd": 123, + "Prtry": 123 + } + }, + "SplmtryData": { + "PlcAndNm": 123, + "Envlp": 123, + "RltdDt": "2013-03-07", + "RltdDtTp": { + "Cd": 123 + } + } + } + }, + "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 + }, + "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" + }, + "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" + } + }, + "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 + } + } + } + } + }, + "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": { + "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": [ - "DEBT", - "CRED", - "SHAR" + "INDA", + "INGA", + "COVE", + "CLRG" ], - "example": "DEBT" + "example": "CLRG" + } + }, + "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 + } + } + } + }, + "ULIDIdentifier": { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + "UUIDv4Identifier": { + "title": "UUIDv4Identifier", + "type": "string", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" + }, + "PaymentIdentification13": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "EndToEndId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "TxId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "UETR": { + "allOf": [ + { + "title": "UUIDv4Identifier", + "type": "string", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" + }, + { + "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" + } + ] + } + }, + "required": [ + "TxId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "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" + }, + "ClearingChannel2Code": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "ExternalServiceLevel1Code": { + "title": "ExternalServiceLevel1Code", + "description": "Specifies the external service level code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "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 }, - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + { + "description": "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" + } + }, + "ExternalLocalInstrument1Code": { + "title": "ExternalLocalInstrument1Code", + "description": "Specifies the external local instrument identification code.", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "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" + } + }, + "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 + }, + "CategoryPurpose1Choice": { + "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" + } + }, + "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": "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" + } + } + }, + "ActiveOrHistoricCurrencyAndAmount_SimpleType": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "PostalAddress27": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "Agt": { + "Issr": { "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" - } - } - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "Tp": { + "SchmeNm": { "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" - } + "title": "Max35Text", + "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\nDefines the type of charges.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Amt", - "Agt" + "Id", + "Issr" ], "example": { - "Amt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - }, - "Agt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "Tp": { - "Cd": "SHAR" - } + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\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", + } + }, + "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" + } + }, + "Max256Text": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "GenericOrganisationIdentification3": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "description": "Information related to an identification of an organisation.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + { + "description": "Identification\nIdentification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + }, + "OrganisationIdentification39": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "allOf": [ + { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "AnyBIC\nBusiness identification code of the organisation.\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericOrganisationIdentification3", + "type": "object", + "description": "Information related to an identification of an organisation.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + { + "description": "Identification\nIdentification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "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" + } + } + }, + "GenericPersonIdentification2": { + "title": "GenericPersonIdentification2", + "type": "object", + "description": "Identification of a person.", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 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" + } + }, + "PersonIdentification18": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "BirthDate\nDate on which a person was born.\n" + } + ] + }, + "PrvcOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ProvinceOfBirth\nProvince where a person was born.\n" + } + ] + }, + "CityOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "CityOfBirth\nCity where a person was born.\n" + } + ] + }, + "CtryOfBirth": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "CountryOfBirth\nCountry where a person was born.\n" + } + ] + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + { + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericPersonIdentification2", + "type": "object", + "description": "Identification of a person.", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "maxLength": 4, + "example": 1234 }, - "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\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 + } + } + } + }, + "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": 16, - "example": 1234567890123456 + "maxLength": 256, + "example": 256 }, - "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + { + "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" + } }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + } + ] + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + } + ] + } + }, + "required": [ + "OrgId" + ] + }, + { + "properties": { + "PrvtId": { + "allOf": [ + { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 + "format": "date", + "example": "2013-03-07" }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 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": 16, - "example": 1234567890123456 + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\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": 70, - "example": 1.2345678901234567e+99 + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "DstrctNm": { - "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": { + { + "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", + { + "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": 70, - "example": 1.2345678901234567e+99 + "maxLength": 256, + "example": 256 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\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" - } - ] - }, - "Id": { - "allOf": [ - { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", - "type": "object", - "anyOf": [ + "SchmeNm": { + "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" - } - ] + "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 }, - "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\nName of the identification scheme, in a coded form as published in an external list.\n" } - } - }, - { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + ] } + }, + "required": [ + "Cd" ] - } - }, - "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" + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "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": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + ], + "example": { + "Cd": "CCPT" } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" } - } + ] }, - { - "description": "Identification\nUnique and unambiguous identification of a 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 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] } - ] + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } }, - "CtryOfRes": { + { + "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" + } + } + } + }, + "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" + }, + "Contact13": { + "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" + } + }, + "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": [ { - "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": { + "Id": { "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": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "example": "DOCT" + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\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 a party is known and which is usually used to identify that party.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "PhneNb": { + "SchmeNm": { "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" - } - ] - }, - "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" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, + "required": [ + "Id", + "Issr" + ], "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "URLAdr": "http://www.example.com", - "EmailAdr": "example@example.com" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ - "Id" - ], - "example": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry" - }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } - }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" - } - } - }, - { - "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "DbtrAcct": { - "allOf": [ - { - "title": "CashAccount40", - "type": "object", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "anyOf": [ + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ + { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "allOf": [ + { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "AnyBIC\nBusiness identification code of the organisation.\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + } + ] + }, + "Othr": { + "allOf": [ { + "title": "GenericOrganisationIdentification3", + "type": "object", + "description": "Information related to an identification of an organisation.\n", "properties": { - "IBAN": { + "Id": { "allOf": [ { - "title": "IBAN2007Identifier", - "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", - "example": "FR1420041010050500013M02606", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" + "minLength": 1, + "maxLength": 256, + "example": 256 }, { - "description": "IBAN\nInternational Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions.\n" + "description": "Identification\nIdentification assigned by an institution.\n" } ] - } - }, - "required": [ - "IBAN" - ] - }, - { - "properties": { - "Othr": { + }, + "SchmeNm": { "allOf": [ { - "title": "GenericAccountIdentification1", + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { - "Id": { + "Cd": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 - }, - { - "description": "Identification\nIdentification assigned by an institution.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "AccountSchemeName1Choice", - "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "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": 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", @@ -50655,74 +47824,263 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, - "required": [ - "Id" + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "Cd": "BIC" } }, { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Othr" - ] + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } - ], - "example": { - "IBAN": "BE71096123456769" - } - }, - { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" + ] } - ] + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } }, - "Tp": { - "allOf": [ - { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\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": { - "Cd": { + "BirthDt": { "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": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: 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\nAccount type, in a coded form.\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": [ - "Cd" - ] + "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": { - "Prtry": { + "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", @@ -50733,711 +48091,1346 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Prtry" - ] + "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": "CACC" - } + ] + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "Type\nSpecifies the nature, or use of the account.\n" + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" - } - ] - }, - "Nm": { + { + "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": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "maxLength": 4, + "example": 1234 }, { - "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": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "Prxy": { + "Id": { "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 - } + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, + "required": [ + "ChanlTp" + ], "example": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" + "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" + } + } + }, + "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" + ] }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 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" + ] } + ], + "example": { + "Cd": "CHIPS" } }, { - "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": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "DbtrAgt": { + "MmbId": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a 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": "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": { - "FinInstnId": { + "Cd": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "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": "Information used to identify a financial institution.\n", + "description": "Generic scheme identification for a party.\n", "properties": { - "BICFI": { + "Id": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 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 - } + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\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 identifier of the financial institution.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "Nm": { + "SchmeNm": { "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": "SchemeName\nShort textual description of the scheme.\n" } ] + } + }, + "required": [ + "Id", + "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 }, - "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", + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 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 + } + } + }, + "BranchData5": { + "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" + } + } + }, + "BranchAndFinancialInstitutionIdentification8": { + "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": 35, - "example": 1.234567890123457e+34 + "maxLength": 5, + "example": 12345 }, - "CtrySubDvsn": { + { + "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", @@ -51445,130 +49438,164 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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\nProprietary identification of the clearing system.\n" } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } + ] + } + }, + "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "Othr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "GenericIdentification30", "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { - "title": "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": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "SchmeNm": { + "Issr": { "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": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "Issr": { + "SchmeNm": { "allOf": [ { "title": "Max35Text", @@ -51579,346 +49606,236 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Id" + "Id", + "Issr" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 - }, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 - } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "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", + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "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": 140, - "example": 12345 + "maxLength": 4, + "example": 1234 }, - "CtrySubDvsn": { + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -51926,195 +49843,209 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } - }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "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": "BIC" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\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": [ - "FinInstnId" + "Id" ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } + "Issr": "BIC" } }, { - "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] + } + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "CdtrAgt": { + "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": "BranchAndFinancialInstitutionIdentification8", + "title": "Max35Text", + "description": "Specifies a character string with a 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": "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": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", - "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 - }, - { - "description": "Code\nClearing system identification code, as published in an external list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nProprietary identification of the clearing system.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "CHIPS" - } + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "MmbId": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -52125,325 +50056,563 @@ "example": 1.234567890123457e+34 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\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": [ - "MmbId" + "Id", + "Issr" ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" - }, - { - "description": "LEI\nLegal entity identifier of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\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" - } + } + }, + "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" + } + } + } + }, + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Dbtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "Othr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "GenericIdentification30", "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "description": "Generic scheme identification for a party.\n", "properties": { "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -52454,24 +50623,291 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "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": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, @@ -52481,14 +50917,7 @@ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { + }, "Prtry": { "allOf": [ { @@ -52505,218 +50934,228 @@ ] } }, - "required": [ - "Prtry" - ] + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "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": "BIC" }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] + "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" }, - "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" + "Issr": "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": 123, - "Prtry": 123 - }, - "Issr": 123 + { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + ] } + }, + "required": [ + "OrgId" ] }, - "BrnchId": { - "allOf": [ - { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "type": "object", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" - }, - { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress27", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + { + "properties": { + "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", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] + "properties": { + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "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": [ { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "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", @@ -52727,255 +51166,140 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "CCPT" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum 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": "DRLC" + }, + "Issr": "BIC" } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\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": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] - } - }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" + } + }, + { + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } - } - }, - { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + ] } + }, + "required": [ + "PrvtId" ] } - }, - "required": [ - "FinInstnId" ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "OrgId": { + "AnyBIC": "BIC" }, - "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" + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" } } } }, { - "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" + "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, - "Cdtr": { + "CtryOfRes": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\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": { + "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": [ { @@ -52991,412 +51315,657 @@ } ] }, - "PstlAdr": { + "PhneNb": { "allOf": [ { - "title": "PostalAddress27", + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + } + ] + }, + "MobNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + } + ] + }, + "FaxNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + } + ] + }, + "URLAdr": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + { + "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" + } + ] + }, + "EmailAdr": { + "allOf": [ + { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + { + "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" + } + ] + }, + "EmailPurp": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + } + ] + }, + "JobTitl": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "JobTitle\nTitle of the function.\n" + } + ] + }, + "Rspnsblty": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Responsibility\nRole of a person in an organisation.\n" + } + ] + }, + "Dept": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Department\nIdentification of a division of a large organisation or building.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", "type": "object", - "description": "Information that locates and identifies a specific 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": [ + { + "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": { - "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" + } }, - "Id": { - "allOf": [ - { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", - "type": "object", - "anyOf": [ + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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": { - "OrgId": { + "AnyBIC": { "allOf": [ { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "AnyBIC\nBusiness identification code of the organisation.\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "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", @@ -53407,1051 +51976,692 @@ "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", + "title": "Max35Text", + "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", - "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": [ + "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": "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": { + "FaxNb": { "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" - } + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" + "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, - "Tp": { + "URLAdr": { "allOf": [ { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\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", - "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": { + "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\nNature or use of the account in a proprietary 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": "CACC" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "Type\nSpecifies the nature, or use of the account.\n" + "description": "OtherContact\nContact details in another form.\n" } ] }, - "Ccy": { + "PrefrdMtd": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "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", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" }, { - "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": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] - }, - "Nm": { + } + }, + "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": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "BICFIDec2014Identifier", "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" }, { - "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, - "Prxy": { + "ClrSysMmbId": { "allOf": [ { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "properties": { - "Tp": { + "ClrSysId": { "allOf": [ { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", "anyOf": [ { @@ -54459,15 +52669,15 @@ "Cd": { "allOf": [ { - "title": "ExternalProxyAccountType1Code", - "description": "Specifies the external proxy account type code.", + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 5, + "example": 12345 }, { - "description": "Code\nProxy account type, in a coded form as published in an external list.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } @@ -54489,7 +52699,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProxy account type, in a proprietary form.\n" + "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } @@ -54500,88 +52710,60 @@ } ], "example": { - "Cd": "EMAIL" + "Cd": "CHIPS" } }, { - "description": "Type\nType of the proxy identification.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "Id": { + "MmbId": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 2048, - "example": 2048 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "Id" + "MmbId" ], "example": { - "Tp": { - "Cd": "IBAN" + "ClrSysId": { + "Cd": "CHQB" }, - "Id": 123 + "MmbId": 123456789 } }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] - } - }, - "example": { - "Id": { - "IBAN": "BE71096123456769" }, - "Tp": { - "Cd": "CACC" - }, - "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": { + "LEI": { "allOf": [ { - "title": "ExternalCreditorAgentInstruction1Code", - "description": "Specifies the instruction given by the creditor to the creditor agent.", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a 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": 4, - "example": 1234 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, - "InstrInf": { + "Nm": { "allOf": [ { "title": "Max140Text", @@ -54592,105 +52774,161 @@ "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" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, - "InstrInf": { + "PstlAdr": { "allOf": [ { - "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": "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", @@ -54698,107 +52936,118 @@ "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" - } - ] + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "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", @@ -54809,272 +53058,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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\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": "Currency\nIdentification of the currency in which the account is held.\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", @@ -55084,479 +53134,542 @@ "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" - } - ] - }, - "Inf": { - "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", - "anyOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "items": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "type": "array" - } - ] - } - }, - "example": { - "Tp": "T1", - "Dt": "2018-01-01", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 - }, - "Inf": 12345 - } - }, - "type": "array" + "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": { + "Id": { "allOf": [ { - "title": "TaxParty1", - "description": "Details about the entity involved in the tax paid or to be paid.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "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": { - "TaxId": { - "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": "TaxIdentification\n\nTax identification number of the creditor.\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" + } }, - "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" - } - ] + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, - "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" - } - ] + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "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": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT" + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "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" } ] }, - "Dbtr": { + "ClrSysMmbId": { "allOf": [ { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\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": { - "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": { + "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": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "TaxTp": { + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -55567,82 +53680,325 @@ "example": 1.234567890123457e+34 }, { - "description": "TaxType\n\nType of tax payer.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - "Authstn": { - "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": "TaxAuthorisation1", - "description": "Details of an authorised tax paying party.\n", - "type": "object", "properties": { - "Titl": { + "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": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "Nm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "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": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } }, { - "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, - "example": { - "Titl": "Mr", - "Nm": "John Doe" - } - }, - { - "description": "Authorisation\n\nDetails of the authorised tax paying party.\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": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT", - "Authstn": { - "Titl": "Mr", - "Nm": "John Doe" - } + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "UltmtDbtr": { + "Othr": { "allOf": [ { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\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": { - "TaxId": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -55653,26 +54009,72 @@ "example": 1.234567890123457e+34 }, { - "description": "TaxIdentification\n\nTax identification number of the debtor.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "RegnId": { + "SchmeNm": { "allOf": [ { - "title": "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": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "TaxTp": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -55683,75 +54085,72 @@ "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" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT", - "Authstn": { - "Titl": "Mr", - "Nm": "John Doe" - } + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] + } + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "AdmstnZone": { + "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", @@ -55762,2203 +54161,25001 @@ "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 - }, - { - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" - } - ] - }, - "TtlTaxAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveOrHistoricCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", - "type": "string", - "example": 123.45, - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" - }, - { - "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" - } - ] - }, - "Dt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" + "maxLength": 140, + "example": 12345 }, { - "description": "Date\n\nDate by which tax is due.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, - "SeqNb": { + "PstlAdr": { "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", + "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": [ - { - "title": "Max35Text", - "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 + "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": { + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" - } - ] - }, - "Dtls": { - "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", - "anyOf": [ - { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", - "type": "object", - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" - } - ] - } - }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } - } - }, - { - "items": { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", - "type": "object", - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" - } - ] - } - }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } - } - }, - "type": "array" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, - "example": { - "Rate": 0, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 0 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 0 - }, - "Dtls": { - "Tp": "T1", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 - }, - "Inf": 12345 - } - } - }, - { - "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" - } - ] - }, - "Tp": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Type\n\nHigh level code to identify the type of tax details.\n" + "required": [ + "Prtry" + ] } - ] - } - }, - "example": { - "Tp": "VAT", - "Ctgy": "A", - "CtgyDtls": "Standard", - "DbtrSts": "Resident", - "CertId": 123456789, - "FrmsCd": 123456789, - "Prd": { - "Yr": 2019, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2019-01-01", - "ToDt": "2019-12-31" + ], + "example": { + "Cd": "ADDR" } }, - "TaxAmt": { - "Rate": 0.2, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 1000 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 200 - } + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, - "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", + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Financial institution servicing an account for the creditor.\n" + } + ] + } + }, + "required": [ + "Dbtr", + "Cdtr", + "DbtrAgt", + "CdtrAgt", + "InstdAmt" + ] + }, + "ActiveCurrencyAndAmount_SimpleType": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", + "example": 123.45 + }, + "ActiveCurrencyCode": { + "title": "ActiveCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + "ActiveCurrencyAndAmount": { + "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", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "BaseOneRate": { + "title": "BaseOneRate", + "type": "string", + "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", + "example": 0.7, + "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" + }, + "ChargeBearerType1Code": { + "title": "ChargeBearerType1Code", + "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR" + ], + "example": "DEBT" + }, + "ExternalChargeType1Code": { + "title": "ExternalChargeType1Code", + "description": "Specifies the type of charge applied to the transaction.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "GenericIdentification3": { + "title": "GenericIdentification3", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "Issr": "BIC" + } + }, + "ChargeType3Choice": { + "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" + } + }, + "Charges16": { + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" + } + ] + }, + "Agt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "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" + } + } + }, + "ExternalCreditorAgentInstruction1Code": { + "title": "ExternalCreditorAgentInstruction1Code", + "description": "Specifies the instruction given by the creditor to the creditor agent.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "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." + } + }, + "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" + }, + "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." + } + }, + "ExternalPurpose1Code": { + "title": "ExternalPurpose1Code", + "description": "Specifies the external purpose code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "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" + } + }, + "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" + }, + "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" + } + }, + "Max10Text": { + "title": "Max10Text", + "description": "Specifies a character string with a maximum length of 10 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 10, + "example": 1234567890 + }, + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" + } + ] + }, + "Inf": { + "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", + "anyOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "items": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "type": "array" + } + ] + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + }, + "RegulatoryReporting3": { + "title": "RegulatoryReporting3", + "description": "Information needed due to regulatory and/or statutory requirements.\n", + "type": "object", + "properties": { + "DbtCdtRptgInd": { + "allOf": [ + { + "title": "RegulatoryReportingType1Code", + "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n", + "type": "string", + "enum": [ + "CRED", + "DEBT", + "BOTH" + ], + "example": "BOTH" + }, + { + "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n" + } + ] + }, + "Authrty": { + "allOf": [ + { + "title": "RegulatoryAuthority2", + "description": "Information about an entity requiring the regulatory reporting information.\n", + "type": "object", + "properties": { + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n" + } + ] + }, + "Ctry": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n" + } + ] + } + }, + "example": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + } + }, + { + "description": "Authority\n\nEntity requiring the regulatory reporting information.\n" + } + ] + }, + "Dtls": { + "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", + "anyOf": [ + { + "title": "StructuredRegulatoryReporting3", + "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", + "type": "object", + "properties": { + "Tp": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" + } + ] + }, + "Dt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" + } + ] + }, + "Ctry": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" + } + ] + }, + "Cd": { + "allOf": [ + { + "title": "Max10Text", + "description": "Specifies a character string with a maximum length of 10 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 10, + "example": 1234567890 + }, + { + "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" + } + ] + }, + "Amt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" + } + ] + }, + "Inf": { + "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", + "anyOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "items": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "type": "array" + } + ] + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + }, + { + "items": { + "title": "StructuredRegulatoryReporting3", + "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" + } + ] + }, + "Inf": { + "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", + "anyOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "items": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "type": "array" + } + ] + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + }, + "type": "array" + } + ] + } + }, + "example": { + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + }, + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" + } + } + }, + "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" + } + }, + "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" + } + }, + "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" + } + } + }, + "Number": { + "title": "Number", + "type": "string", + "example": 256, + "pattern": "^(?!0\\d)\\d{1,18}$" + }, + "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" + } + }, + "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" + }, + "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 + }, + "TaxPeriod3": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "FromDate\nStart date of the range.\n" + } + ] + }, + "ToDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "ToDate\nEnd date of the range.\n" + } + ] + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" + } + }, + { + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" + } + ] + }, + "Tp": { + "allOf": [ + { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + { + "description": "Type\n\nIdentification of the period related to the tax payment.\n" + } + ] + }, + "Yr": { + "allOf": [ + { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + { + "description": "Year\n\nYear related to the tax payment.\n" + } + ] + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "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})$" + }, + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + } + ] + }, + "TtlAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + } + ] + }, + "Dtls": { + "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", + "anyOf": [ + { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + { + "items": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + "type": "array" + } + ] + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "TaxRecord3": { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "properties": { + "AddtlInf": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "AdditionalInformation\n\nFurther details of the tax record.\n" + } + ] + }, + "CertId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" + } + ] + }, + "Ctgy": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" + } + ] + }, + "CtgyDtls": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" + } + ] + }, + "DbtrSts": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" + } + ] + }, + "FrmsCd": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" + } + ] + }, + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "FromDate\nStart date of the range.\n" + } + ] + }, + "ToDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "ToDate\nEnd date of the range.\n" + } + ] + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" + } + }, + { + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" + } + ] + }, + "Tp": { + "allOf": [ + { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + { + "description": "Type\n\nIdentification of the period related to the tax payment.\n" + } + ] + }, + "Yr": { + "allOf": [ + { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + { + "description": "Year\n\nYear related to the tax payment.\n" + } + ] + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + { + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + } + ] + }, + "TaxAmt": { + "allOf": [ + { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { + "allOf": [ + { + "title": "PercentageRate", + "type": "string", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + } + ] + }, + "TtlAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + } + ] + }, + "Dtls": { + "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", + "anyOf": [ + { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + { + "items": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + "type": "array" + } + ] + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + { + "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" + } + ] + }, + "Tp": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Type\n\nHigh level code to identify the type of tax details.\n" + } + ] + } + }, + "example": { + "Tp": "VAT", + "Ctgy": "A", + "CtgyDtls": "Standard", + "DbtrSts": "Resident", + "CertId": 123456789, + "FrmsCd": 123456789, + "Prd": { + "Yr": 2019, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2019-01-01", + "ToDt": "2019-12-31" + } + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 1000 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 200 + } + }, + "AddtlInf": "VAT applicable" + } + }, + "TaxData1": { + "title": "TaxData1", + "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n", + "type": "object", + "properties": { + "Cdtr": { + "allOf": [ + { + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "TaxIdentification\n\nTax identification number of the creditor.\n" + } + ] + }, + "RegnId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" + } + ] + }, + "TaxTp": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "TaxType\n\nType of tax payer.\n" + } + ] + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT" + } + }, + { + "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" + } + ] + }, + "Dbtr": { + "allOf": [ + { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "TaxIdentification\n\nTax identification number of the debtor.\n" + } + ] + }, + "RegnId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" + } + ] + }, + "TaxTp": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "TaxType\n\nType of tax payer.\n" + } + ] + }, + "Authstn": { + "allOf": [ + { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" + } + ] + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + }, + { + "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" + } + ] + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + { + "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" + } + ] + }, + "UltmtDbtr": { + "allOf": [ + { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "TaxIdentification\n\nTax identification number of the debtor.\n" + } + ] + }, + "RegnId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" + } + ] + }, + "TaxTp": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "TaxType\n\nType of tax payer.\n" + } + ] + }, + "Authstn": { + "allOf": [ + { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" + } + ] + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + }, + { + "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" + } + ] + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + { + "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n" + } + ] + }, + "AdmstnZone": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n" + } + ] + }, + "RefNb": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n" + } + ] + }, + "Mtd": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n" + } + ] + }, + "TtlTaxblBaseAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" + } + ] + }, + "TtlTaxAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" + } + ] + }, + "Dt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "Date\n\nDate by which tax is due.\n" + } + ] + }, + "SeqNb": { + "allOf": [ + { + "title": "Number", + "type": "string", + "example": 256, + "pattern": "^(?!0\\d)\\d{1,18}$" + }, + { + "description": "SequenceNumber\n\nSequential number of the tax report.\n" + } + ] + }, + "Rcrd": { + "description": "Record\n\nDetails of the tax record.\n", + "anyOf": [ + { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + } + ] + }, + "TtlAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + } + ] + }, + "Dtls": { + "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", + "anyOf": [ + { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + { + "items": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + "type": "array" + } + ] + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + { + "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" + } + ] + }, + "Tp": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Type\n\nHigh level code to identify the type of tax details.\n" + } + ] + } + }, + "example": { + "Tp": "VAT", + "Ctgy": "A", + "CtgyDtls": "Standard", + "DbtrSts": "Resident", + "CertId": 123456789, + "FrmsCd": 123456789, + "Prd": { + "Yr": 2019, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2019-01-01", + "ToDt": "2019-12-31" + } + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 1000 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 200 + } + }, + "AddtlInf": "VAT applicable" + } + }, + { + "items": { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + } + ] + }, + "TtlAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + } + ] + }, + "Dtls": { + "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", + "anyOf": [ + { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + { + "items": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + "type": "array" + } + ] + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + { + "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" + } + ] + }, + "Tp": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Type\n\nHigh level code to identify the type of tax details.\n" + } + ] + } + }, + "example": { + "Tp": "VAT", + "Ctgy": "A", + "CtgyDtls": "Standard", + "DbtrSts": "Resident", + "CertId": 123456789, + "FrmsCd": 123456789, + "Prd": { + "Yr": 2019, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2019-01-01", + "ToDt": "2019-12-31" + } + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 1000 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 200 + } + }, + "AddtlInf": "VAT applicable" + } + }, + "type": "array" + } + ] + } + }, + "example": { + "Cdtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "Dbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "UltmtDbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "AdmstnZone": "CH", + "RefNb": 12345, + "Mtd": "A", + "TtlTaxblBaseAmt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "TtlTaxAmt": { + "Ccy": "CHF", + "Amt": 100 + }, + "Dt": "2018-01-01", + "SeqNb": 1, + "Rcrd": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "hexBinary": { + "title": "hexBinary", + "type": "string", + "example": 4660, + "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" + }, + "Exact32HexBinaryText": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + "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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + { + "description": "SHA-256 signature of the terms\n" + } + ] + } + }, + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + }, + "CreditTransferTransaction67": { + "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": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "EndToEndId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "TxId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "UETR": { + "allOf": [ + { + "title": "UUIDv4Identifier", + "type": "string", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" + }, + { + "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" + } + ] + } + }, + "required": [ + "TxId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + { + "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" + } + ] + }, + "PmtTpInf": { + "allOf": [ + { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Dbtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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" + } + ] + } + }, + "required": [ + "Dbtr", + "Cdtr", + "DbtrAgt", + "CdtrAgt", + "InstdAmt" + ] + }, + { + "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", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" + } + ] + }, + "InstdAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "XchgRate": { + "allOf": [ + { + "title": "BaseOneRate", + "type": "string", + "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", + "example": 0.7, + "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" + }, + { + "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n" + } + ] + }, + "ChrgBr": { + "title": "ChargeBearerType1Code", + "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR" + ], + "example": "DEBT" + }, + "ChrgsInf": { + "allOf": [ + { + "title": "Charges16", + "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" + } + ] + }, + "Agt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" + } + ] + }, + "Inf": { + "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", + "anyOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "items": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "type": "array" + } + ] + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + }, + { + "items": { + "title": "StructuredRegulatoryReporting3", + "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", + "type": "object", + "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", - "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": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" + } + ] + }, + "Inf": { + "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", + "anyOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "items": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "type": "array" + } + ] + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + }, + "type": "array" + } + ] + } + }, + "example": { + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + }, + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" + } + } + }, + { + "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" + } + ] + }, + "Tax": { + "allOf": [ + { + "title": "TaxData1", + "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" + } + ] + }, + "TtlTaxAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" + } + ] + }, + "Dt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "Date\n\nDate by which tax is due.\n" + } + ] + }, + "SeqNb": { + "allOf": [ + { + "title": "Number", + "type": "string", + "example": 256, + "pattern": "^(?!0\\d)\\d{1,18}$" + }, + { + "description": "SequenceNumber\n\nSequential number of the tax report.\n" + } + ] + }, + "Rcrd": { + "description": "Record\n\nDetails of the tax record.\n", + "anyOf": [ + { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + } + ] + }, + "TtlAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + } + ] + }, + "Dtls": { + "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", + "anyOf": [ + { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } }, - { - "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } } - ] - }, - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + }, + { + "items": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", "type": "object", "properties": { - "FrToDt": { + "Prd": { "allOf": [ { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", "type": "object", "properties": { - "FrDt": { + "FrToDt": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. 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": "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", - "format": "date", - "example": "2013-03-07" + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" }, { - "description": "FromDate\nStart date of the range.\n" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "ToDt": { + "Yr": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. 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": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", - "format": "date", - "example": "2013-03-07" + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 }, { - "description": "ToDate\nEnd date of the range.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, - "required": [ - "FrDt", - "ToDt" - ], "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-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" + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, - "TaxblBaseAmt": { + "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", @@ -58155,26 +79352,916 @@ ] }, { - "description": "Currency\nIdentification of the currency in which the account is held.\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\nUnderlying tax amount related to the specified period.\n" + } + ] + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + "type": "array" + } + ] + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + { + "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" + } + ] + }, + "Tp": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Type\n\nHigh level code to identify the type of tax details.\n" + } + ] + } + }, + "example": { + "Tp": "VAT", + "Ctgy": "A", + "CtgyDtls": "Standard", + "DbtrSts": "Resident", + "CertId": 123456789, + "FrmsCd": 123456789, + "Prd": { + "Yr": 2019, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2019-01-01", + "ToDt": "2019-12-31" + } + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 1000 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 200 + } + }, + "AddtlInf": "VAT applicable" + } + }, + { + "items": { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "properties": { + "AddtlInf": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "AdditionalInformation\n\nFurther details of the tax record.\n" + } + ] + }, + "CertId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" + } + ] + }, + "Ctgy": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" + } + ] + }, + "CtgyDtls": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" + } + ] + }, + "DbtrSts": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" + } + ] + }, + "FrmsCd": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" + } + ] + }, + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "FromDate\nStart date of the range.\n" + } + ] + }, + "ToDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "ToDate\nEnd date of the range.\n" + } + ] + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" + } + }, + { + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" + } + ] + }, + "Tp": { + "allOf": [ + { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + { + "description": "Type\n\nIdentification of the period related to the tax payment.\n" + } + ] + }, + "Yr": { + "allOf": [ + { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + { + "description": "Year\n\nYear related to the tax payment.\n" + } + ] + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + { + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + } + ] + }, + "TaxAmt": { + "allOf": [ + { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { + "allOf": [ + { + "title": "PercentageRate", + "type": "string", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + } + ] + }, + "TtlAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + } + ] + }, + "Dtls": { + "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", + "anyOf": [ + { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "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": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } } }, { - "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, - "TtlAmt": { + "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", @@ -58257,2602 +80344,818 @@ "GIP", "GMD", "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" - } - ] - }, - "Dtls": { - "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", - "anyOf": [ - { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", - "type": "object", - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" - } - ] - } - }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } - } - }, - { - "items": { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", - "type": "object", - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" - } - ] - } - }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } + ] } }, - "type": "array" + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, + "required": [ + "Amt" + ], "example": { - "Rate": 0, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 0 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 0 + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } }, - "Dtls": { - "Tp": "T1", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 - }, - "Inf": 12345 + "Amt": { + "Amt": 100, + "Ccy": "EUR" } } }, { - "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" - } - ] - }, - "Tp": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Type\n\nHigh level code to identify the type of tax details.\n" - } - ] - } - }, - "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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", - "type": "string", - "pattern": "^[A-Za-z0-9-_]{43}$", - "maxLength": 48 - }, - { - "description": "SHA-256 signature of the terms\n" - } - ] - } - }, - "required": [ - "Sh256Sgntr" - ] - } - ], - "example": { - "IlpV4PrepPacket": "1234567890ABCDEF" - } - } - }, - "required": [ - "PmtId", - "IntrBkSttlmAmt", - "ChrgBr", - "Dbtr", - "DbtrAgt", - "CdtrAgt", - "Cdtr" - ], - "example": { - "PmtId": { - "InstrId": "INSTRID", - "EndToEndId": "ENDTOENDID" - }, - "PmtTpInf": { - "LclInstrm": { - "Cd": "CHQB", - "Prtry": "PROPRIETARY" - }, - "SeqTp": "SEQTP" - }, - "IntrBkSttlmAmt": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" - }, - "InstdAmt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - }, - "XchgRate": 123.45, - "ChrgBr": "SHAR", - "ChrgsInf": { - "Amt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - }, - "Agt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "Tp": { - "Cd": "SHAR" - } - }, - "Dbtr": { - "Nm": "NAME", - "PstlAdr": { - "AdrTp": "ADDR", - "BldgNb": "BLDGNB", - "Ctry": "CTRY", - "TwnNm": "TWNNM", - "PstCd": "PSTCD", - "StrtNm": "STRTNM" - } - }, - "DbtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "DbtrAgt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "CdtrAgt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "Cdtr": { - "Nm": "NAME", - "PstlAdr": { - "AdrTp": "ADDR", - "BldgNb": "BLDGNB", - "Ctry": "CTRY", - "TwnNm": "TWNNM", - "PstCd": "PSTCD", - "StrtNm": "STRTNM" - } - }, - "CdtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "InstrForCdtrAgt": { - "Cd": "CODE" - }, - "InstrForNxtAgt": { - "Cd": "CODE" - }, - "Purp": { - "Cd": "CASH" - }, - "RgltryRptg": { - "Dbtr": true, - "Cdtr": true - }, - "Tax": "Cdtr" - } - }, - { - "description": "Credit Transfer Transaction Information\nSet of elements providing information specific to the individual credit transfer(s).\n" - } - ] - } - }, - "required": [ - "GrpHdr", - "CdtTrfTxInf" - ], - "example": { - "GrpHdr": { - "MsgId": 12345, - "CreDtTm": "2020-01-01T00:00:00Z", - "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", - "NbOfTxs": 1, - "SttlmInf": { - "SttlmMtd": "INDA", - "SttlmAcct": { - "Id": { - "IBAN": 123 - } - }, - "SttlmAcctOwnr": { - "Nm": "John Doe" - }, - "SttlmAcctSvcr": { - "BICFI": 123 - } - } - }, - "CdtTrfTxInf": { - "PmtId": { - "InstrId": 123, - "EndToEndId": 123 - }, - "PmtTpInf": { - "InstrPrty": "NORM" - }, - "InstdAmt": { - "Amt": 123, - "Ccy": "EUR" - }, - "ChrgBr": "SHAR", - "CdtrAgt": { - "FinInstnId": { - "BICFI": 123 - } - }, - "Cdtr": { - "Nm": "John Doe" - }, - "CdtrAcct": { - "Id": { - "IBAN": 123 - } - }, - "RmtInf": { - "Ustrd": "Test" - } - } - } - }, - "Extension": { - "title": "Extension", - "type": "object", - "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}\n\nNOTE: enum enforcement is not apart of the ISO20022 specification, but is added here for FSPIOP mappings.\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": "COMM", - "enum": [ - "COMM", - "RESV", - "RECV", - "ABOR" - ] - }, - "ExternalPersonIdentification1Code": { - "title": "ExternalPersonIdentification1Code", - "description": "Specifies the external person identification code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - "ExternalProxyAccountType1Code": { - "title": "ExternalProxyAccountType1Code", - "description": "Specifies the external proxy account type code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - "ExternalPurpose1Code": { - "title": "ExternalPurpose1Code", - "description": "Specifies the external purpose code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - "ExternalServiceLevel1Code": { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - "ExternalStatusReason1Code": { - "title": "ExternalStatusReason1Code", - "description": "Specifies the external status reason code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - "ExternalVerificationReason1Code": { - "title": "ExternalVerificationReason1Code", - "description": "Specifies the external verification reason code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - "FinancialIdentificationSchemeName1Choice": { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "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" - } - ] + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + "type": "array" + } + ] + } }, - "SchmeNm": { - "allOf": [ - { - "title": "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": "SchemeName\nShort textual description of the scheme.\n" - } - ] + "Inf": 12345 + } } }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + { + "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\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" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 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" - } - ] - } + "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", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + { + "description": "Type\n\nHigh level code to identify the type of tax details.\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 + ] + } + }, + "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" }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "Dbtr": { + "Titl": "Mr", + "Nm": "John Doe" }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "UltmtDbtr": { + "Titl": "Mr", + "Nm": "John Doe" }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "AdmstnZone": "CH", + "RefNb": 12345, + "Mtd": "A", + "TtlTaxblBaseAmt": { + "Ccy": "CHF", + "Amt": 1000 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + "TtlTaxAmt": { + "Ccy": "CHF", + "Amt": 100 }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "Dt": "2018-01-01", + "SeqNb": 1, + "Rcrd": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "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": "Tax\nProvides details on the tax.\n" } ] }, - "Othr": { - "allOf": [ + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "Cryptographically signed terms\n", + "type": "object", + "anyOf": [ { - "title": "GenericFinancialIdentification1", - "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { - "Id": { + "IlpV4PrepPacket": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "hexBinary", "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" - } + "example": 4660, + "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" } ] - }, - "Issr": { + } + }, + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "properties": { + "Sh256Sgntr": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "SHA-256 signature of the terms\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" + "Sh256Sgntr" + ] } - ] + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } } }, - "required": [], + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr", + "Purp" + ], "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" }, - "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" + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + }, + "SeqTp": "SEQTP" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 + "IntrBkSttlmAmt": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "InstdAmt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "XchgRate": 123.45, + "ChrgBr": "SHAR", + "ChrgsInf": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" }, - "Issr": 123 - } + "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" } }, - "FxRequest_FICreditTransferProposal": { - "title": "FxRequest_FICreditTransferProposal", + "TermsRequest_FIToFICustomerCreditProposal": { + "title": "TermsRequest_FIToFICustomerCreditProposal", "type": "object", - "description": "FxRequest_FICreditTransferProposal\nA group of elements providing information specific to the individual credit transfer(s) included in the message.\n", + "description": "This message is sent by a financial institution to a financial institution to propose the terms of a credit to a customer.\n", "properties": { "GrpHdr": { "allOf": [ { - "title": "GroupHeader113", - "description": "Set of characteristics shared by all individual transactions included in the message.\n", + "title": "GroupHeader129", + "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", "properties": { "MsgId": { @@ -60884,230 +81187,31 @@ } ] }, - "NbOfTxs": { + "PmtInstrXpryDtTm": { "allOf": [ { - "title": "Max15NumericText", - "description": "Specifies a numeric string with a maximum length of 15 digits.\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": "^[0-9]{1,15}$", - "example": 123456789012345 + "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": "Number of Transactions\n" + "description": "Payment Instruction Expiry Date and Time\n" } ] }, - "TtlIntrBkSttlmAmt": { + "NbOfTxs": { "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", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "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": "Total Interbank Settlement Amount\n" + "description": "Number of Transactions\n" } ] }, @@ -61129,230 +81233,6 @@ "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": [ @@ -61404,237 +81284,6 @@ "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": [ @@ -61646,46 +81295,33 @@ "example": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z", + "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", "NbOfTxs": 1, - "TtlIntrBkSttlmAmt": { - "Ccy": "EUR", - "Value": 100 - }, "SttlmInf": { "SttlmMtd": "INDA", "SttlmAcct": { "Id": { - "IBAN": "BE71096123456769" - }, - "Ccy": "EUR" + "IBAN": 123 + } }, "SttlmAcctOwnr": { - "Nm": "Name" + "Nm": "John Doe" }, "SttlmAcctSvcr": { - "Nm": "Name" - }, - "SttlmAgt": { - "FinInstnId": { - "BICFI": "BIC" - } + "BICFI": 123 } - }, - "PmtTpInf": { - "InstrPrty": "NORM", - "CtgyPurp": "CASH" } } }, { - "description": "GroupHeader\nSet of characteristics shared by all individual transactions included in the message.\n" + "description": "Group Header\nSet of characteristics shared by all individual transactions included in the message.\n" } ] }, "CdtTrfTxInf": { "allOf": [ { - "title": "CreditTransferTransaction68_FX_Quotes", + "title": "CreditTransferTransaction67", "description": "Provides further details specific to the individual transaction(s) included in the message.\n", "type": "object", "properties": { @@ -64151,7 +83787,760 @@ } ] }, - "JobTitl": { + "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", @@ -64162,172 +84551,370 @@ "example": 1.234567890123457e+34 }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "Rspnsblty": { + "LEI": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, - "Dept": { + "Nm": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "maxLength": 140, + "example": 12345 }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, - "Othr": { + "PstlAdr": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "PostalAddress27", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "ChanlTp": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "Id": { - "allOf": [ - { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 128, - "example": 12345 - }, - { - "description": "Identifier\nCommunication value such as phone number or email address.\n" - } - ] + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } }, - "required": [ - "ChanlTp" - ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "OtherContact\nContact details in another form.\n" - } - ] - }, - "PrefrdMtd": { - "allOf": [ - { - "title": "PreferredContactMethod2Code", - "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", - "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "MAIL" - }, - { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "URLAdr": "http://www.example.com", - "EmailAdr": "example@example.com" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "Id" + "FinInstnId" ], "example": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" } - }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" } } }, { - "description": "Party to which an amount of money is due.\n" + "description": "Financial institution servicing an account for the debtor.\n" } ] }, - "DbtrAgt": { + "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", @@ -65243,42 +85830,733 @@ } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\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": "Financial institution servicing an account for the creditor.\n" + } + ] + } + }, + "required": [ + "Dbtr", + "Cdtr", + "DbtrAgt", + "CdtrAgt", + "InstdAmt" + ] + }, + { + "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", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" + } + ] + }, + "InstdAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "XchgRate": { + "allOf": [ + { + "title": "BaseOneRate", + "type": "string", + "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", + "example": 0.7, + "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" + }, + { + "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n" + } + ] + }, + "ChrgBr": { + "title": "ChargeBearerType1Code", + "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR" + ], + "example": "DEBT" + }, + "ChrgsInf": { + "allOf": [ + { + "title": "Charges16", + "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ - "FinInstnId" + "ActiveOrHistoricCurrencyAndAmount", + "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" - } - } + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "Financial institution servicing an account for the debtor.\n" + "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" } ] }, - "CdtrAgt": { + "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", @@ -66225,708 +87503,793 @@ } }, { - "description": "Financial institution servicing an account for the creditor.\n" - } - ] - } - }, - "required": [ - "Dbtr", - "Cdtr", - "DbtrAgt", - "CdtrAgt" - ] - }, - { - "description": "Underlying Customer Credit Transfer\nTBD\n" - } - ] - }, - "IntrBkSttlmAmt": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "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 + "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" } ] }, - "Ccy": { + "Tp": { "allOf": [ { - "title": "ActiveCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Type\nDefines the type of charges.\n" } ] } }, "required": [ - "ActiveCurrencyAndAmount", - "Ccy" + "Amt", + "Agt" ], "example": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } } }, { - "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" + "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n" } ] }, "Dbtr": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FinInstnId": { + "Nm": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress27", "type": "object", - "description": "Information used to identify a financial institution.\n", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "BICFI": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "BICFIDec2014Identifier", - "type": "string", - "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\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": "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": { + "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": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ + { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] + "properties": { + "AnyBIC": { + "allOf": [ + { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "AnyBIC\nBusiness identification code of the organisation.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericOrganisationIdentification3", + "type": "object", + "description": "Information related to an identification of an organisation.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + { + "description": "Identification\nIdentification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] } - ] - }, - "SchmeNm": { - "allOf": [ + }, + "anyOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "properties": { + "Cd": {} + } }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "properties": { + "Prtry": {} + } } - ] + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } + ] }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] } - ] + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "ADDR" + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + ] } + }, + "required": [ + "OrgId" ] }, - "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": { + "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": { - "Cd": { + "BirthDt": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution 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" + } + ] + }, + "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": [ - "Cd" - ] + "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": { - "Prtry": { + "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", @@ -66937,102 +88300,195 @@ "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": "DRLC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } - ], - "example": { - "Cd": "BIC" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" + ] } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] - } - }, - "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": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + } + ] } + }, + "required": [ + "PrvtId" ] } - }, - "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" + "OrgId": { + "AnyBIC": "BIC" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + "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", @@ -67043,361 +88499,178 @@ "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" } } }, @@ -67945,7 +89218,7 @@ } }, { - "description": "DebtorAccount\nAccount used to process a payment.\n" + "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n" } ] }, @@ -68896,962 +90169,11 @@ } }, { - "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" + "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" } ] }, - "Cdtr": { + "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", @@ -70798,982 +91120,1291 @@ } }, { - "description": "Creditor\nParty to which an amount of money is due.\n" + "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, - "CdtrAcct": { + "Cdtr": { "allOf": [ { - "title": "CashAccount40", + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", - "description": "Provides the details to identify an account.\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", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "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": "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": { + "OrgId": { "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": "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": "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": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ - "IBAN" + "OrgId" ] }, { "properties": { - "Othr": { + "PrvtId": { "allOf": [ { - "title": "GenericAccountIdentification1", + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { - "Id": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 + "title": "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": "Identification\nIdentification assigned by an institution.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, - "SchmeNm": { + "Othr": { "allOf": [ { - "title": "AccountSchemeName1Choice", + "title": "GenericPersonIdentification2", "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": "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": "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": "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" + ] }, { - "description": "Proprietary\nName of the identification scheme, in a free text 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\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": [ - "Prtry" ] } + }, + "required": [ + "Id" ], "example": { - "Cd": 1111 + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "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 a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Id" - ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - "Issr": "BIC" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } } }, { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ - "Othr" + "PrvtId" ] } ], "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" - ] + "OrgId": { + "AnyBIC": "BIC" }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } - ], - "example": { - "Cd": "CACC" } }, { - "description": "Type\nSpecifies the nature, or use of the account.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + "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", + "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": "ExternalProxyAccountType1Code", - "description": "Specifies the external proxy account type code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nProxy account type, in a coded form as published in an external list.\n" - } - ] + "properties": { + "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\nProxy account type, in a proprietary 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": "EMAIL" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "Type\nType of the proxy identification.\n" + "description": "OtherContact\nContact details in another form.\n" } ] }, - "Id": { + "PrefrdMtd": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 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": 2048, - "example": 2048 + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" }, { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, - "required": [ - "Id" - ], "example": { - "Tp": { - "Cd": "IBAN" - }, - "Id": 123 + "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": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" - } - ] - } - }, - "example": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" - }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 - } - } - }, - { - "description": "CreditorAccount\nAccount to which a credit entry is made.\n" - } - ] - }, - "InstrForCdtrAgt": { - "allOf": [ - { - "title": "InstructionForCreditorAgent3_Put_FX_Quotes_ID", - "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", - "type": "object", - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalCreditorAgentInstruction1Code", - "description": "Specifies the instruction given by the creditor to the creditor agent.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" - } - ] - }, - "InstrInf": { - "allOf": [ - { - "title": "AmountTypeEnum", - "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", - "type": "string", - "enum": [ - "SEND", - "RECEIVE" - ], - "example": "SEND" - }, - { - "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", - "type": "string", - "pattern": "^[A-Za-z0-9-_]{43}$", - "maxLength": 48 - }, - { - "description": "SHA-256 signature of the terms\n" - } - ] - } - }, - "required": [ - "Sh256Sgntr" - ] - } + "required": [ + "Id" ], "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 + "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": "Number of Transactions\n" + "description": "Creditor\nParty to which an amount of money is due.\n" } ] }, - "TtlIntrBkSttlmAmt": { + "CdtrAcct": { "allOf": [ { - "title": "ActiveCurrencyAndAmount", + "title": "CashAccount40", "type": "object", - "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "description": "Provides the details to identify an account.\n", "properties": { - "ActiveCurrencyAndAmount": { + "Id": { "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 + "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": "ActiveCurrencyCode", + "title": "ActiveOrHistoricCurrencyCode", "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, @@ -71945,503 +92576,987 @@ ] }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "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" } ] } }, - "required": [ - "ActiveCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } } }, { - "description": "Total Interbank Settlement Amount\n" + "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" } ] }, - "SttlmInf": { + "InstrForCdtrAgt": { "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": "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": { - "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" + "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" + } + ] }, - "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", + "InstrInf": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", - "enum": [ - "HIGH", - "NORM" - ], - "example": "HIGH" + "minLength": 1, + "maxLength": 140, + "example": 12345 }, - "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": "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": [ - "RTGS", - "RTNS", - "MPNS", - "BOOK" + "PHOA", + "TELA" ], - "example": "RTGS" + "example": "PHOA" }, - "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": "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 }, - "LclInstrm": { + { + "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": "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": "ExternalPurpose1Code", + "description": "Specifies the external purpose code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" + "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" } ] - }, - "CtgyPurp": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "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": "Proprietary\n\nPurpose, in a proprietary form.\n" } ] } }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" - }, - "CtgyPurp": { - "Cd": "CASH" - } - } + "required": [ + "Prtry" + ] } - }, - "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 - } - } - } + "Cd": "CH03" } }, { - "description": "Settlement Information\n" + "description": "Purpose\nUnderlying reason for the payment transaction.\n" } ] }, - "PmtTpInf": { + "RgltryRptg": { "allOf": [ { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", + "title": "RegulatoryReporting3", + "description": "Information needed due to regulatory and/or statutory requirements.\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" + "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" + } + ] }, - "SvcLvl": { + "Authrty": { "allOf": [ { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", + "title": "RegulatoryAuthority2", + "description": "Information about an entity requiring the regulatory reporting information.\n", "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "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" + } + ] }, - { - "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] } - ] + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "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": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "SEPA" + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 } }, { - "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" - } - ] - } + "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" + } + ] }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] - } + "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" + } + ] }, - "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 + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } }, - { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\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": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "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", @@ -72449,428 +93564,610 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Proprietary\nCategory purpose, in a proprietary form.\n" - } - ] - } + "type": "array" + } + ] + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 }, - "required": [ - "Prtry" - ] + "Inf": 12345 } - ], - "example": { - "Cd": "CASH" - } - }, - { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + }, + "type": "array" } ] } }, "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" }, - "CtgyPurp": { - "Cd": "CASH" + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" } } }, { - "description": "Payment Type Information\n" + "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" } ] - } - }, - "required": [ - "MsgId", - "CreDtTm", - "NbOfTxs", - "SttlmInf" - ], - "example": { - "MsgId": 12345, - "CreDtTm": "2020-01-01T00:00:00Z", - "NbOfTxs": 1, - "TtlIntrBkSttlmAmt": { - "Ccy": "EUR", - "Value": 100 - }, - "SttlmInf": { - "SttlmMtd": "INDA", - "SttlmAcct": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Ccy": "EUR" - }, - "SttlmAcctOwnr": { - "Nm": "Name" - }, - "SttlmAcctSvcr": { - "Nm": "Name" - }, - "SttlmAgt": { - "FinInstnId": { - "BICFI": "BIC" - } - } }, - "PmtTpInf": { - "InstrPrty": "NORM", - "CtgyPurp": "CASH" - } - } - }, - { - "description": "GroupHeader\nSet of characteristics shared by all individual transactions included in the message.\n" - } - ] - }, - "CdtTrfTxInf": { - "allOf": [ - { - "title": "CreditTransferTransaction68_FX_Quotes", - "description": "Provides further details specific to the individual transaction(s) included in the message.\n", - "type": "object", - "properties": { - "PmtId": { + "Tax": { "allOf": [ { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\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": { - "InstrId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" - }, - { - "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" - } - ] - }, - "ClrSysRef": { + "Cdtr": { "allOf": [ { - "title": "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": "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": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" + "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\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": { + "Dbtr": { "allOf": [ { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\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": "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 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 a pre-agreed service or level of service between the parties, 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": "SEPA" + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } } }, { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" + "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" } ] }, - "LclInstrm": { + "UltmtDbtr": { "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": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n" } ] }, - "CtgyPurp": { + "AdmstnZone": { "allOf": [ { - "title": "CategoryPurpose1Choice", - "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\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": "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", - "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" - } - ] + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of 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\nCategory purpose, in a proprietary 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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" } - }, - "required": [ - "Prtry" ] } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" ], "example": { - "Cd": "CASH" + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\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": { + "TtlTaxAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", @@ -73082,18 +94379,46 @@ } }, { - "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": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" } ] }, - "Dbtr": { + "Dt": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\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": { - "Nm": { + "AddtlInf": { "allOf": [ { "title": "Max140Text", @@ -73104,2148 +94429,4274 @@ "example": 12345 }, { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "description": "AdditionalInformation\n\nFurther details of the tax record.\n" } ] }, - "PstlAdr": { + "CertId": { "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": "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": "Information that locates and identifies a 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", + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: 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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + } + ] + }, + "TtlAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "example": "ADDR" + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ - "Cd" - ] + "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": { - "Prtry": { + "Prd": { "allOf": [ { - "title": "GenericIdentification30", + "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", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, - "Issr": { + "Tp": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "SchmeNm": { + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, - "required": [ - "Id", - "Issr" - ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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" - } - }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "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" - } - ] + }, + "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})$" }, - "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": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" ] }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "Currency\nIdentification of the currency in which the account is held.\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" + "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" } }, - { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "Amt": { + "Amt": 100, + "Ccy": "EUR" } - ] - } - }, - "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" + } + }, + { + "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" + } + ] + } }, - { - "description": "CountryOfBirth\nCountry where a person was born.\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": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" - ], - "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" + "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": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-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" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 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" - } - ] - } + }, + { + "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" + } + ] }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] } }, - { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } - ] - } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } - } + ] } }, - { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\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": [ - "PrvtId" ] } - ], + }, "example": { - "OrgId": { - "AnyBIC": "BIC" + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 } } }, { - "description": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } ] }, - "CtryOfRes": { + "Tp": { "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" - }, - { - "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" - } + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "Type\n\nHigh level code to identify the type of tax details.\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" + "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" + } }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 1000 }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "TtlAmt": { + "Ccy": "EUR", + "Amt": 200 } }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" - } + "AddtlInf": "VAT applicable" } }, { - "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" - } - ] + "items": { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "properties": { + "AddtlInf": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "AdditionalInformation\n\nFurther details of the tax record.\n" + } + ] + }, + "CertId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" + } + ] + }, + "Ctgy": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" + } + ] + }, + "CtgyDtls": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" + } + ] + }, + "DbtrSts": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" + } + ] + }, + "FrmsCd": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" + } + ] + }, + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "FromDate\nStart date of the range.\n" + } + ] + }, + "ToDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "ToDate\nEnd date of the range.\n" + } + ] + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" + } + }, + { + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" + } + ] + }, + "Tp": { + "allOf": [ + { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + { + "description": "Type\n\nIdentification of the period related to the tax payment.\n" + } + ] + }, + "Yr": { + "allOf": [ + { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + { + "description": "Year\n\nYear related to the tax payment.\n" + } + ] + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + { + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + } + ] + }, + "TaxAmt": { + "allOf": [ + { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { + "allOf": [ + { + "title": "PercentageRate", + "type": "string", + "example": 1234, + "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" + }, + { + "description": "Rate\n\nRate used to calculate the tax.\n" + } + ] + }, + "TaxblBaseAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, - "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": "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})$" }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + { + "description": "Amount of 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": "Proprietary\nType of address expressed as a proprietary code.\n" - } - ] + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, - "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": {} + { + "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" } - }, - { - "properties": { - "Prtry": {} + ] + }, + "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" } - } - ], - "example": { - "Cd": "BIC" + ] } }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\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": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" + "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": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" } }, - "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } + "Amt": { + "Amt": 100, + "Ccy": "EUR" } - }, - { - "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", + }, + { + "items": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", "type": "object", "properties": { - "DtAndPlcOfBirth": { + "Prd": { "allOf": [ { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\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": { + "FrToDt": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "FromDate\nStart date of the range.\n" + } + ] + }, + "ToDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "ToDate\nEnd date of the range.\n" + } + ] + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" + } }, { - "description": "ProvinceOfBirth\nProvince where a person was born.\n" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, - "CityOfBirth": { + "Tp": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" }, { - "description": "CityOfBirth\nCity where a person was born.\n" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "CtryOfBirth": { + "Yr": { "allOf": [ { - "title": "CountryCode", + "title": "ISOYear", + "description": "Year represented by YYYY (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" + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 }, { - "description": "CountryOfBirth\nCountry where a person was born.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, - "required": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" - ], "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } } }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth 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" } ] }, - "Othr": { + "Amt": { "allOf": [ { - "title": "GenericPersonIdentification2", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", - "description": "Identification of a person.", + "description": "A number of 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": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "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" - } + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { - "description": "SchemeName\nName of the identification scheme.\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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ - "Id" + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, + "required": [ + "Amt" + ], "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" } } }, - { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" - } - ] - } - }, - "required": [ - "PrvtId" - ] - } - ], - "example": { - "OrgId": { - "AnyBIC": "BIC" + "type": "array" + } + ] + } }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "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 }, - { - "description": "Identification\nUnique and unambiguous identification of a party.\n" + "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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + { + "description": "SHA-256 signature of the terms\n" + } + ] + } + }, + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr", + "Purp" + ], + "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" + } + } + } + } + }, + "GroupHeader129b": { + "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" + } + }, + "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", + "PmtInstrXpryDtTm" + ], + "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 + } + } + } + }, + "CreditTransferTransaction67b": { + "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": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "EndToEndId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "TxId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "UETR": { + "allOf": [ + { + "title": "UUIDv4Identifier", + "type": "string", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" + }, + { + "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" + } + ] + } + }, + "required": [ + "TxId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + { + "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" + } + ] + }, + "PmtTpInf": { + "allOf": [ + { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "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 }, - "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": "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 }, - "CtctDtls": { - "allOf": [ + { + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Dbtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Contact13", - "description": "Specifies the details of the contact person.\n", - "type": "object", "properties": { - "NmPrfx": { + "Cd": { "allOf": [ { - "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ - "DOCT", - "MADM", - "MISS", - "MIST", - "MIKS" + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" ], "type": "string", - "example": "DOCT" - }, - { - "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" - } - ] - }, - "PhneNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" - }, - { - "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" - } - ] - }, - "MobNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" - }, - { - "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" - } - ] - }, - "FaxNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" - }, - { - "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" - } - ] - }, - "URLAdr": { - "allOf": [ - { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 - }, - { - "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" - } - ] - }, - "EmailAdr": { - "allOf": [ - { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 - }, - { - "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" - } - ] - }, - "EmailPurp": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" - } - ] - }, - "JobTitl": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "JobTitle\nTitle of the function.\n" - } - ] - }, - "Rspnsblty": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Responsibility\nRole of a person in an organisation.\n" - } - ] - }, - "Dept": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "example": "ADDR" }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "Othr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "GenericIdentification30", "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "ChanlTp": { + "Id": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 4, + "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "Id": { + "Issr": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 128, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "ChanlTp" + "Id", + "Issr" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "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": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, - "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "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": [ + "Prtry" + ] } + ], + "example": { + "Cd": "ADDR" } }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "Party to which an amount of money is due.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "DbtrAgt": { + "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" - } - ] - }, - "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": [ + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[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" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { + }, "Prtry": { "allOf": [ { @@ -75257,163 +98708,233 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, - "required": [ - "Prtry" - ] + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\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" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\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 + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" }, - { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" - } - ] - } - }, - "required": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" + "Issr": "BIC" + } }, - "MmbId": 123456789 - } - }, - { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + } + ] } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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" + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" } - ] + } }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + { + "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" + } + ] }, - { - "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", @@ -75424,188 +98945,500 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "CCPT" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum 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": "DRLC" + }, + "Issr": "BIC" } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\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" + ] + } + }, + "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "Othr": { + "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": "GenericFinancialIdentification1", + "title": "GenericIdentification30", "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "description": "Generic scheme identification for a party.\n", "properties": { "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -75616,24 +99449,291 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "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": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, @@ -75643,14 +99743,7 @@ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { + }, "Prtry": { "allOf": [ { @@ -75667,218 +99760,228 @@ ] } }, - "required": [ - "Prtry" - ] + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "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": "BIC" }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] + "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" }, - "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" + "Issr": "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": 123, - "Prtry": 123 - }, - "Issr": 123 + { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + ] } + }, + "required": [ + "OrgId" ] }, - "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 + { + "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": "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", + "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", @@ -75889,824 +99992,839 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "CCPT" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum 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": "DRLC" + }, + "Issr": "BIC" } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\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": { + "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + }, + { + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, + "required": [ + "ChanlTp" + ], "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "OtherContact\nContact details in another form.\n" + } + ] + }, + "PrefrdMtd": { + "allOf": [ + { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + }, + { + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, - "required": [ - "FinInstnId" - ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" } }, { - "description": "Financial institution servicing an account for the debtor.\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" }, - "CdtrAgt": { + "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": "BranchAndFinancialInstitutionIdentification8", + "title": "FinancialInstitutionIdentification23", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "description": "Information used to identify a financial institution.\n", "properties": { - "FinInstnId": { + "BICFI": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + } + ] + }, + "ClrSysMmbId": { + "allOf": [ + { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", - "description": "Information used to identify a financial institution.\n", "properties": { - "BICFI": { - "allOf": [ - { - "title": "BICFIDec2014Identifier", - "type": "string", - "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - { - "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" - } - ] - }, - "ClrSysMmbId": { + "ClrSysId": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nProprietary identification of the clearing system.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "MmbId" ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Cd": "CHIPS" } }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "LEI": { + "MmbId": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "LEI\nLegal entity identifier of the financial institution.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - "Nm": { - "allOf": [ + "MmbId": 123456789 + } + }, + { + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identifier of the financial institution.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "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" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "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" + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "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": [ @@ -76719,596 +100837,522 @@ "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" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Prtry" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - ], - "example": { - "Cd": "ADDR" - } - }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + ] } }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } }, "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, - "required": [ - "FinInstnId" - ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" } } }, { - "description": "Financial institution servicing an account for the creditor.\n" - } - ] - } - }, - "required": [ - "Dbtr", - "Cdtr", - "DbtrAgt", - "CdtrAgt" - ] - }, - { - "description": "Underlying Customer Credit Transfer\nTBD\n" - } - ] - }, - "IntrBkSttlmAmt": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount_SimpleType", - "type": "string", - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", - "example": 123.45 - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "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": "Financial institution servicing an account for the debtor.\n" } ] }, - "Dbtr": { + "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", @@ -78255,235 +102299,502 @@ } }, { - "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" + "description": "Financial institution servicing an account for the creditor.\n" + } + ] + } + }, + "required": [ + "Dbtr", + "Cdtr", + "DbtrAgt", + "CdtrAgt", + "InstdAmt" + ] + }, + { + "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", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" + } + ] + }, + "InstdAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] - }, - "DbtrAcct": { + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "XchgRate": { + "allOf": [ + { + "title": "BaseOneRate", + "type": "string", + "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", + "example": 0.7, + "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" + }, + { + "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n" + } + ] + }, + "ChrgBr": { + "title": "ChargeBearerType1Code", + "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR" + ], + "example": "DEBT" + }, + "ChrgsInf": { + "allOf": [ + { + "title": "Charges16", + "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n", + "type": "object", + "properties": { + "Amt": { "allOf": [ { - "title": "CashAccount40", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", - "description": "Provides the details to identify an account.\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": "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": { + "ActiveOrHistoricCurrencyAndAmount": { "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": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{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\nSpecifies the nature, or use of the account.\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" } ] }, @@ -78664,145 +102975,26 @@ ] }, { - "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" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], "example": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" - }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 - } + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "DebtorAccount\nAccount used to process a payment.\n" + "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" } ] }, - "DbtrAgt": { + "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", @@ -79390,493 +103582,7 @@ "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" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, @@ -79890,7 +103596,7 @@ "example": "529900T8BM49AURSDO55" }, { - "description": "LEI\nLegal entity identifier of the financial institution.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, @@ -79905,14 +103611,14 @@ "example": 12345 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { - "title": "PostalAddress24", + "title": "PostalAddress27", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -80027,6 +103733,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", @@ -80044,12 +103758,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", @@ -80060,12 +103774,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", @@ -80075,6 +103789,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", @@ -80100,28 +103822,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", @@ -80149,12 +103871,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", @@ -80170,15 +103894,267 @@ "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" + } + ] + }, + "Tp": { + "allOf": [ + { + "title": "ChargeType3Choice", + "description": "ChargeType3Choice\nSpecifies the type of charge.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalChargeType1Code", + "description": "Specifies the type of charge applied to the transaction.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, - "Othr": { + { + "description": "Code\nCharge type, in a coded form.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification3", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "Issr": "BIC" + } + }, + { + "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + }, + { + "description": "Type\nDefines the type of charges.\n" + } + ] + } + }, + "required": [ + "Amt", + "Agt" + ], + "example": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + } + }, + { + "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n" + } + ] + }, + "Dbtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "description": "Generic scheme identification for a party.\n", "properties": { "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -80189,24 +104165,291 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "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": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, @@ -80216,14 +104459,7 @@ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { + }, "Prtry": { "allOf": [ { @@ -80240,171 +104476,727 @@ ] } }, - "required": [ - "Prtry" - ] + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "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" + } + ] } - ] + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "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": "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" + } + ] }, - { - "description": "Issuer\nEntity that assigns the identification.\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": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + ] + }, + "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" + } }, - "Issr": "BIC" - } + { + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + } + ] + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 - }, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" + } }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + { + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } - } + ] + } + }, + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + { + "description": "Identification\nUnique and unambiguous identification of a party.\n" + } + ] + }, + "CtryOfRes": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" + } + ] + }, + "CtctDtls": { + "allOf": [ + { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "allOf": [ + { + "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, - "BrnchId": { + "Nm": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PhneNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + } + ] + }, + "MobNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + } + ] + }, + "FaxNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + } + ] + }, + "URLAdr": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + { + "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" + } + ] + }, + "EmailAdr": { + "allOf": [ + { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + { + "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" + } + ] + }, + "EmailPurp": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + } + ] + }, + "JobTitl": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "JobTitle\nTitle of the function.\n" + } + ] + }, + "Rspnsblty": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Responsibility\nRole of a person in an organisation.\n" + } + ] + }, + "Dept": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Department\nIdentification of a division of a large organisation or building.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", "type": "object", "properties": { - "Id": { + "ChanlTp": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "maxLength": 4, + "example": 1234 }, { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "Nm": { + "Id": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, + "maxLength": 128, "example": 12345 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + { + "description": "OtherContact\nContact details in another form.\n" + } + ] + }, + "PrefrdMtd": { + "allOf": [ + { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + }, + { + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + } + ] + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + }, + { + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + { + "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" + } + ] + }, + "DbtrAcct": { + "allOf": [ + { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "anyOf": [ + { + "properties": { + "IBAN": { + "allOf": [ + { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "example": "FR1420041010050500013M02606", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress27", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + { + "description": "IBAN\nInternational Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions.\n" + } + ] + } + }, + "required": [ + "IBAN" + ] + }, + { + "properties": { + "Othr": { + "allOf": [ + { + "title": "GenericAccountIdentification1", + "type": "object", + "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + { + "description": "Identification\nIdentification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "AccountSchemeName1Choice", "type": "object", - "description": "Choice of formats for the type of address.\n", + "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" } ] } @@ -80418,67 +105210,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" } ] } @@ -80489,122 +105229,359 @@ } ], "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", + { + "description": "SchemeName\nName of the identification 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 }, - "DstrctNm": { - "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": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "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": 140, - "example": 12345 + "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", @@ -80612,1170 +105589,549 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "Proprietary\nProxy account type, in a proprietary form.\n" } - }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + ] } + }, + "required": [ + "Prtry" ] } - }, + ], "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "Cd": "EMAIL" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Type\nType of the proxy identification.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + { + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ - "FinInstnId" + "Id" ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "Tp": { + "Cd": "IBAN" }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } + "Id": 123 } }, { - "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" }, - "Cdtr": { + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + { + "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n" + } + ] + }, + "DbtrAgt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "FinancialInstitutionIdentification23", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "description": "Information used to identify a financial institution.\n", "properties": { - "FinInstnId": { + "BICFI": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + } + ] + }, + "ClrSysMmbId": { + "allOf": [ + { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", - "description": "Information used to identify a financial institution.\n", "properties": { - "BICFI": { - "allOf": [ - { - "title": "BICFIDec2014Identifier", - "type": "string", - "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - { - "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" - } - ] - }, - "ClrSysMmbId": { + "ClrSysId": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nProprietary identification of the clearing system.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "MmbId" ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Cd": "CHIPS" } }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": "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 - }, - { - "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" - } + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, - "required": [], + "required": [ + "MmbId" + ], "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" + "ClrSysId": { + "Cd": "CHQB" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 - } + "MmbId": 123456789 } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "BrnchId": { + "LEI": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identifier of the financial institution.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress27", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "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": "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": "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": { + "Othr": { "allOf": [ { - "title": "AccountIdentification4Choice", + "title": "GenericFinancialIdentification1", "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": "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": [ - "IBAN" ] }, - { - "properties": { - "Othr": { - "allOf": [ + "SchmeNm": { + "allOf": [ + { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "description": "Specifies the name of the identification scheme.\n", + "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": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 - }, - { - "description": "Identification\nIdentification assigned by an institution.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "AccountSchemeName1Choice", - "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "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": 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", @@ -81786,327 +106142,936 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\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": [ - "Othr" ] } + }, + "required": [ + "Id" ], "example": { - "IBAN": "BE71096123456769" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] + } + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "Tp": { + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 + } + } + }, + { + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + } + ] + }, + "BrnchId": { + "allOf": [ + { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { "allOf": [ { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the 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 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", - "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": "Information that locates and identifies a 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\nNature or use of the account 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" ] } - }, - "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": "CACC" + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "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": "Type\nSpecifies the nature, or use of the account.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] - }, - "Ccy": { + } + }, + "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": "ActiveOrHistoricCurrencyCode", + "title": "BICFIDec2014Identifier", "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "description": "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": "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": "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": "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": "PostalAddress24", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Tp": { + "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": "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" } ] } @@ -82128,7 +107093,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" } ] } @@ -82139,26 +107104,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" } ] } @@ -82167,121 +107132,337 @@ "Id" ], "example": { - "Tp": { + "Id": 123, + "SchmeNm": { "Cd": "IBAN" }, - "Id": 123 + "Issr": "BIC" } }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, + "required": [], "example": { - "Id": { - "IBAN": "BE71096123456769" + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "Tp": { - "Cd": "CACC" + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "CreditorAccount\nAccount to which a credit entry is made.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "InstrForCdtrAgt": { + "BrnchId": { "allOf": [ { - "title": "InstructionForCreditorAgent3_Put_FX_Quotes_ID", - "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalCreditorAgentInstruction1Code", - "description": "Specifies the instruction given by the creditor to the creditor agent.", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "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": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "InstrInf": { + "LEI": { "allOf": [ { - "title": "AmountTypeEnum", - "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a 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": [ - "SEND", - "RECEIVE" - ], - "example": "SEND" + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "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": "LEI\nLegal entity identification for the branch of the financial institution.\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" - } - ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "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", @@ -82289,405 +107470,183 @@ "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", + "Ctry": { + "title": "CountryCode", "type": "string", - "example": 4660, - "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, - { - "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" - } - ] - } - }, - "required": [ - "IlpV4PrepPacket" - ] - }, - { - "properties": { - "Sh256Sgntr": { - "allOf": [ - { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "pattern": "^[A-Za-z0-9-_]{43}$", - "maxLength": 48 - }, - { - "description": "SHA-256 signature of the terms\n" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] - } - }, - "required": [ - "Sh256Sgntr" - ] - } - ], - "example": { - "IlpV4PrepPacket": "1234567890ABCDEF" - } - }, - { - "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" - } - ] - } - }, - "required": [ - "PmtId", - "IntrBkSttlmAmt", - "Dbtr", - "Cdtr" - ], - "example": { - "PmtId": { - "InstrId": "INSTRID", - "EndToEndId": "ENDTOENDID" - }, - "PmtTpInf": { - "LclInstrm": { - "Cd": "CHQB", - "Prtry": "PROPRIETARY" - } - }, - "IntrBkSttlmAmt": { - "Amount": 123.45, - "Ccy": "EUR" - }, - "Dbtr": { - "Nm": "Debtor Name" - }, - "DbtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "DbtrAgt": { - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "CdtrAgt": { - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "Cdtr": { - "Nm": "Creditor Name" - }, - "CdtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "InstrForCdtrAgt": { - "Cd": "INSTRUCTION" - }, - "Purp": { - "Cd": "CHAR" - }, - "VrfctnOfTerms": { - "Cntt": "CONTENT", - "CnttTp": "PROPRIETARY" - } - } - }, - { - "description": "CreditTransferTransaction68_FX_Quotes\nSet of elements providing information specific to the individual credit transfer(s).\n" - } - ] - } - }, - "required": [ - "GrpHdr", - "CdtTrfTxInf" - ], - "example": { - "GrpHdr": { - "MsgId": "20191122-123456", - "CreDtTm": "2019-11-22T12:34:56", - "NbOfTxs": 1, - "CtrlSum": 100, - "InitgPty": { - "Nm": "Initiating Party Name" - }, - "MsgRcpt": { - "Nm": "Message Recipient Name" - } - }, - "CdtTrfTxInf": { - "PmtId": { - "InstrId": "20191122-123456", - "EndToEndId": "20191122-123456" - }, - "PmtTpInf": { - "InstrPrty": "NORM", - "CtgyPurp": "SUPP" - }, - "IntrBkSttlmAmt": { - "Amt": 100, - "Ccy": "EUR" - }, - "ChrgBr": "SHAR", - "Cdtr": { - "Nm": "Creditor Name" - }, - "CdtrAcct": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" - }, - "Ccy": "EUR", - "Nm": "My account" - }, - "CdtrAgt": { - "FinInstnId": { - "BICFI": "BNBABEBB" - } - }, - "CdtrAgtAcct": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" - }, - "Ccy": "EUR", - "Nm": "My account" - }, - "Dbtr": { - "Nm": "Debtor Name" - }, - "DbtrAcct": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" - }, - "Ccy": "EUR", - "Nm": "My account" - }, - "DbtrAgt": { - "FinInstnId": { - "BICFI": "BNBABEBB" - } - }, - "DbtrAgtAcct": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" - }, - "Ccy": "EUR", - "Nm": "My account" - }, - "RmtInf": { - "Ustrd": "Remittance Information" - }, - "RgltryRptg": { - "Dbtr": { - "Nm": "Debtor Name" - }, - "DbtrAcct": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "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" + } + ] + } }, - "Ccy": "EUR", - "Nm": "My account" + "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" } - } - } - } - }, - "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": { + ] + }, + "Cdtr": { "allOf": [ { - "title": "GroupHeader129", - "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n", + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "properties": { - "MsgId": { + "Nm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "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 + "maxLength": 140, + "example": 12345 }, { - "description": "Number of Transactions\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, - "SttlmInf": { + "PstlAdr": { "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": "PostalAddress27", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "SttlmMtd": { - "title": "SettlementMethod1Code", - "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n", - "type": "string", - "enum": [ - "INDA", - "INGA", - "COVE", - "CLRG" - ], - "example": "CLRG" - }, - "PmtTpInf": { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", + "AdrTp": { + "title": "AddressType3Choice", "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" + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, - "SvcLvl": { - "allOf": [ - { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", - "type": "object", - "anyOf": [ + { + "properties": { + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level 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\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code 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", @@ -82698,312 +107657,768 @@ "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" - ] - } - ], - "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": { + }, + "SchmeNm": { "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": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Cd" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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" + } + ] }, - { - "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\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": "CH03" + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } } }, { - "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": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] - }, - "CtgyPurp": { + } + }, + "required": [ + "OrgId" + ] + }, + { + "properties": { + "PrvtId": { "allOf": [ { - "title": "CategoryPurpose1Choice", - "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\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 + "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": "Code\nCategory purpose, as published in an external category purpose code list.\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": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "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": "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": "Proprietary\nCategory purpose, in a proprietary form.\n" + "SchmeNm": { + "allOf": [ + { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] } - ] + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "CASH" + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } } }, { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" - }, - "CtgyPurp": { - "Cd": "CASH" - } - } + "required": [ + "PrvtId" + ] } - }, - "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 - } + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" } } } }, { - "description": "Settlement Information\n" + "description": "Identification\nUnique and unambiguous identification of a party.\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 + }, + "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" } - }, - "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": { + ] + }, + "CtctDtls": { "allOf": [ { - "title": "PaymentIdentification13", - "description": "Provides further means of referencing a payment transaction.\n", + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", "type": "object", "properties": { - "InstrId": { + "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": "ULIDIdentifier", + "title": "PhoneNumber", "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { - "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, - "EndToEndId": { + "MobNb": { "allOf": [ { - "title": "ULIDIdentifier", + "title": "PhoneNumber", "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { - "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, - "TxId": { + "FaxNb": { "allOf": [ { - "title": "ULIDIdentifier", + "title": "PhoneNumber", "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, - "UETR": { + "URLAdr": { "allOf": [ { - "title": "UUIDv4Identifier", + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\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}$" + "minLength": 1, + "maxLength": 2048, + "example": 2048 }, { - "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, - "ClrSysRef": { + "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", @@ -83014,149 +108429,307 @@ "example": 1.234567890123457e+34 }, { - "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" + "description": "EmailPurpose\nPurpose for which an email address may be used.\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" + "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" + } + ] }, - "SvcLvl": { + "Rspnsblty": { "allOf": [ { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\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": "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": "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": { + "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\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\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": "SEPA" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" + "description": "OtherContact\nContact details in another form.\n" } ] }, - "LclInstrm": { + "PrefrdMtd": { "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": "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": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalLocalInstrument1Code", - "description": "Specifies the external local instrument identification code.", + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 12345 + "maxLength": 34, + "example": 1.2345678901234568e+33 }, { - "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" + "description": "Identification\nIdentification assigned by an institution.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "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", @@ -83167,30 +108740,311 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nSpecifies the local instrument, 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 account, as assigned by the account servicer, using an identification scheme.\n" } - ], - "example": { - "Cd": "CH03" - } - }, - { - "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" + ] + } + }, + "required": [ + "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" ] }, - "CtgyPurp": { + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + { + "description": "Type\nSpecifies the nature, or use of the account.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { "allOf": [ { - "title": "CategoryPurpose1Choice", - "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", "type": "object", "anyOf": [ { @@ -83198,14 +109052,15 @@ "Cd": { "allOf": [ { - "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", - "maxLength": 4, - "minLength": 1, + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", "type": "string", + "minLength": 1, + "maxLength": 4, "example": 1234 }, { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } @@ -83227,7 +109082,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nCategory purpose, in a proprietary form.\n" + "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } @@ -83238,5617 +109093,5290 @@ } ], "example": { - "Cd": "CASH" + "Cd": "EMAIL" } }, { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\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": [ + "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": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" - }, - "CtgyPurp": { - "Cd": "CASH" - } + "Nm": "Swiss National Bank", + "Ctry": "CH" } }, { - "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" + "description": "Authority\n\nEntity requiring the regulatory reporting information.\n" } ] }, - "UndrlygCstmrCdtTrf": { - "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": "UnderlyingCustomerCreditTransfer", + "title": "StructuredRegulatoryReporting3", + "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", "type": "object", "properties": { - "InstdAmt": { + "Tp": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveOrHistoricCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", - "type": "string", - "example": 123.45, - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" - }, - { - "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "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": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" } ] }, - "Dbtr": { + "Dt": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\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 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": { - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 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": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "CountryCode", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, 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": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { - "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": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" } ] }, - "CtctDtls": { + "Ccy": { "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": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ - "Id" + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" ], "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" - } + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "Party that owes an amount of money to the (ultimate) creditor.\n" + "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" } ] }, - "Cdtr": { - "allOf": [ + "Inf": { + "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", + "anyOf": [ { - "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 - } + "title": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "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": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] + ] + } }, - "Id": { + "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": "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" - } - } - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\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\n\nName of the debtor or the debtor's authorised representative.\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" - } + } + }, + "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": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\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" + "Nm": { + "allOf": [ + { + "title": "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" } - } - }, - "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": { + "Titl": "Mr", + "Nm": "John Doe" } }, { - "description": "Party to which an amount of money is due.\n" + "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" + } + ] + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + { + "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n" + } + ] + }, + "AdmstnZone": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n" + } + ] + }, + "RefNb": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n" + } + ] + }, + "Mtd": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n" + } + ] + }, + "TtlTaxblBaseAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" } ] }, - "DbtrAgt": { + "Ccy": { "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" - } + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" + } + ] + }, + "TtlTaxAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" + } + ] + }, + "Dt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "Date\n\nDate by which tax is due.\n" + } + ] + }, + "SeqNb": { + "allOf": [ + { + "title": "Number", + "type": "string", + "example": 256, + "pattern": "^(?!0\\d)\\d{1,18}$" + }, + { + "description": "SequenceNumber\n\nSequential number of the tax report.\n" + } + ] + }, + "Rcrd": { + "description": "Record\n\nDetails of the tax record.\n", + "anyOf": [ + { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "FromDate\nStart date of the range.\n" } ] }, - "Othr": { + "ToDt": { "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": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "ToDate\nEnd date of the range.\n" } ] } }, - "required": [], + "required": [ + "FrDt", + "ToDt" + ], "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 - } + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a 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" } ] }, - "BrnchId": { + "Tp": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + { + "description": "Type\n\nIdentification of the period related to the tax payment.\n" + } + ] + }, + "Yr": { + "allOf": [ + { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + { + "description": "Year\n\nYear related to the tax payment.\n" + } + ] + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + { + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + } + ] + }, + "TaxAmt": { + "allOf": [ + { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { + "allOf": [ + { + "title": "PercentageRate", + "type": "string", + "example": 1234, + "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" + }, + { + "description": "Rate\n\nRate used to calculate the tax.\n" + } + ] + }, + "TaxblBaseAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { - "Id": { + "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": "Identification\nUnique and unambiguous identification of a branch of a 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" } ] }, - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] - }, - "Nm": { + } + }, + "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": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { - "description": "Name\nName by which 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" } ] }, - "PstlAdr": { + "Ccy": { "allOf": [ { - "title": "PostalAddress27", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "ADDR" - } - }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "PostalAddress\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" } ] } }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\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": [ + "Dtls": { + "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", + "anyOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\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": { + "Prd": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", "type": "object", "properties": { - "ClrSysId": { + "FrToDt": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\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": { + "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\nProprietary identification of the clearing system.\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": { - "Cd": "CHIPS" + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, - "MmbId": { + "Tp": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Type\n\nIdentification of the period related to the tax payment.\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": [ + "Yr": { + "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": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\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": "Year\n\nYear related to the tax payment.\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" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, - "Othr": { + "Amt": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "description": "A number of 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": "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": "Identification\nUnique and unambiguous identification of a person.\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": "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" - } - ] - } + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + { + "items": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "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": [ - "Cd" - ] + "ToDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "ToDate\nEnd date of the range.\n" + } + ] + } }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } - ], - "example": { - "Cd": "BIC" + }, + { + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] + ] + } }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum 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" } }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } - }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" - } - ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 - }, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" + ] + } }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } }, - "Issr": 123 + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + }, + "type": "array" } ] + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 }, - "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" - } - ] + "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" + } + ] + } }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 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": [ + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } }, - "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 - } + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "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" } }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + { + "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\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": "Financial institution servicing an account for the creditor.\n" - } - ] - } - }, - "required": [ - "Dbtr", - "Cdtr", - "DbtrAgt", - "CdtrAgt" - ] - }, - { - "description": "Underlying Customer Credit Transfer\nTBD\n" - } - ] - }, - "IntrBkSttlmAmt": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount_SimpleType", - "type": "string", - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", - "example": 123.45 - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" - } - ] - }, - "Dbtr": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "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 + ] + }, + "Dtls": { + "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", + "anyOf": [ + { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "properties": { + "Prd": { + "allOf": [ + { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "FrToDt": { + "allOf": [ + { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "FromDate\nStart date of the range.\n" + } + ] + }, + "ToDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "ToDate\nEnd date of the range.\n" + } + ] + } }, - { - "description": "Code\nClearing system identification code, 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" + } + ] }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] - } + "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": [ - "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" - } - ] + "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" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum 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": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" - } - ] + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "ADDR" + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\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": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } } }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "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": [ + { + "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": { - "Cd": { + "FrToDt": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", + "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": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ - "Prtry" - ] + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } - ], - "example": { - "Cd": "BIC" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" + ] } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + }, + "required": [ + "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" + "type": "array" } + ] + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" - } - ] + "Inf": 12345 + } } }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 - }, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - }, + { + "description": "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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + { + "description": "SHA-256 signature of the terms\n" + } + ] + } + }, + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr", + "VrfctnOfTerms" + ], + "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" + } + }, + "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" + } + }, + "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", + "PmtInstrXpryDtTm" + ], + "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": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, { - "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\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\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", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "DstrctNm": { - "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": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\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\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "TxId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "UETR": { + "allOf": [ + { + "title": "UUIDv4Identifier", + "type": "string", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" + }, + { + "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" } ] } }, "required": [ - "FinInstnId" + "TxId" ], "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" - } - } + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" } }, { - "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" + "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" } ] }, - "DbtrAcct": { + "PmtTpInf": { "allOf": [ { - "title": "CashAccount40", + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", "type": "object", - "description": "Provides the details to identify an account.\n", "properties": { - "Id": { + "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": "AccountIdentification4Choice", + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { - "IBAN": { + "Cd": { "allOf": [ { - "title": "IBAN2007Identifier", - "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "title": "ExternalServiceLevel1Code", + "description": "Specifies the external service level code.", "type": "string", - "example": "FR1420041010050500013M02606", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "IBAN\nInternational Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions.\n" + "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ - "IBAN" + "Cd" ] }, { "properties": { - "Othr": { + "Prtry": { "allOf": [ { - "title": "GenericAccountIdentification1", - "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", - "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": "Other\nUnique identification of an account, as assigned by the account servicer, 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": [ - "Othr" + "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" } ] } @@ -88870,7 +114398,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" } ] } @@ -88881,470 +114409,323 @@ } ], "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - { - "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + "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" - }, - "Tp": { - "Cd": "CACC" + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" } } }, { - "description": "DebtorAccount\nAccount used to process a payment.\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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "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": [ { @@ -89356,14 +114737,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": { @@ -89478,6 +114859,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", @@ -89495,12 +114884,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", @@ -89511,12 +114900,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", @@ -89526,6 +114915,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", @@ -89551,28 +114948,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", @@ -89600,12 +114997,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", @@ -89618,18 +115017,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", + "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", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { - "Id": { + "NmPrfx": { + "allOf": [ + { + "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + { + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PhneNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + } + ] + }, + "MobNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + } + ] + }, + "FaxNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + } + ] + }, + "URLAdr": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + { + "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" + } + ] + }, + "EmailAdr": { + "allOf": [ + { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + { + "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" + } + ] + }, + "EmailPurp": { "allOf": [ { "title": "Max35Text", @@ -89640,176 +115586,193 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, - "SchmeNm": { + "JobTitl": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "JobTitle\nTitle of the function.\n" + } + ] + }, + "Rspnsblty": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Responsibility\nRole of a person in an organisation.\n" + } + ] + }, + "Dept": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Department\nIdentification of a division of a large organisation or building.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "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": [ { @@ -89821,7 +115784,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" } ] }, @@ -90101,484 +116064,1331 @@ } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "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": { - "Id": 123, - "LEI": 123, - "Nm": "Name", + "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" + "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": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Party to which an amount of money is due.\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": { + "DbtrAgt": { "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": [ - { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", - "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "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" + ] }, { - "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": [ @@ -90591,945 +117401,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", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[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" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\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": [ - "Cd" - ] + ], + "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 }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "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 debtor.\n" } ] }, - "BrnchId": { + "CdtrAgt": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a 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": "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": { + "FinInstnId": { "allOf": [ { - "title": "PostalAddress27", + "title": "FinancialInstitutionIdentification23", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "description": "Information used to identify a financial institution.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "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": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + { + "description": "Code\nClearing system identification code, as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nProprietary identification of the clearing system.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } ], + "example": { + "Cd": "CHIPS" + } + }, + { + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + } + ] + }, + "MmbId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "example": "ADDR" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "Cd" - ] + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + { + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identifier of the financial institution.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Prtry": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "example": "ADDR" }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "SchmeNm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "ADDR" - } - }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] - } - }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } - } - }, - { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" - } - ] - } - }, - "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - } - }, - { - "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" - } - ] - }, - "Cdtr": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "description": "Information used to identify a financial institution.\n", - "properties": { - "BICFI": { - "allOf": [ - { - "title": "BICFIDec2014Identifier", - "type": "string", - "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - { - "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" - } - ] - }, - "ClrSysMmbId": { - "allOf": [ - { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", - "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 - }, - { - "description": "Code\nClearing system identification code, as published in an external list.\n" - } + "Prtry" ] } - }, - "required": [ - "Cd" - ] + ], + "example": { + "Cd": "ADDR" + } }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "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": "CHIPS" + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "MmbId": { + "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": "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": [ - { + "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": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "example": "ADDR" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "SchmeNm": { "allOf": [ { - "title": "GenericIdentification30", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] } + }, + "required": [ + "Cd" ] }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Id", - "Issr" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Cd": "BIC" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Prtry" - ] + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } - ], - "example": { - "Cd": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + ] } }, + "required": [], "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 + }, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 + } } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution 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": [ @@ -91542,986 +118352,270 @@ "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" + ] } - ] - } - }, - "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", + ], + "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": 34, - "example": 1.2345678901234568e+33 + "maxLength": 16, + "example": 1234567890123456 }, - { - "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 - } + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "Room": { + "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": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - { - "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" - } - ] - }, - "Prxy": { - "allOf": [ - { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", - "type": "object", - "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.", + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 16, + "example": 1234567890123456 }, - { - "description": "Code\nProxy account type, in a coded form as published in an external list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "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", @@ -92529,1284 +118623,856 @@ "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 } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "EMAIL" - } - }, - { - "description": "Type\nType of the proxy identification.\n" - } - ] - }, - "Id": { - "allOf": [ - { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 - }, - { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Tp": { - "Cd": "IBAN" - }, - "Id": 123 - } - }, - { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" - } - ] - } - }, - "example": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" - }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 - } - } - }, - { - "description": "CreditorAccount\nAccount to which a credit entry is made.\n" - } - ] - }, - "InstrForCdtrAgt": { - "allOf": [ - { - "title": "InstructionForCreditorAgent3", - "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", - "type": "object", - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalCreditorAgentInstruction1Code", - "description": "Specifies the instruction given by the creditor to the creditor agent.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" - } - ] - }, - "InstrInf": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" - } - ] - } - }, - "example": { - "Cd": "PHOA", - "InstrInf": "Please advise/contact next agent by phone." - } - }, - { - "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" - } - ] - }, - "Purp": { - "allOf": [ - { - "title": "Purpose2Choice", - "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", - "type": "object", - "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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", - "type": "string", - "pattern": "^[A-Za-z0-9-_]{43}$", - "maxLength": 48 - }, - { - "description": "SHA-256 signature of the terms\n" - } - ] - } - }, - "required": [ - "Sh256Sgntr" - ] - } - ], - "example": { - "IlpV4PrepPacket": "1234567890ABCDEF" - } - }, - { - "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" - } - ] - } - }, - "required": [ - "PmtId", - "IntrBkSttlmAmt", - "Dbtr", - "Cdtr" - ], - "example": { - "PmtId": { - "InstrId": "INSTRID", - "EndToEndId": "ENDTOENDID" - }, - "PmtTpInf": { - "LclInstrm": { - "Cd": "CHQB", - "Prtry": "PROPRIETARY" - } - }, - "IntrBkSttlmAmt": { - "Amount": 123.45, - "Ccy": "EUR" - }, - "Dbtr": { - "Nm": "Debtor Name" - }, - "DbtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "DbtrAgt": { - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "CdtrAgt": { - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "Cdtr": { - "Nm": "Creditor Name" - }, - "CdtrAcct": { - "Id": { - "IBAN": "IBAN" - } - }, - "InstrForCdtrAgt": { - "Cd": "INSTRUCTION" - }, - "Purp": { - "Cd": "CHAR" - }, - "VrfctnOfTerms": { - "Cntt": "CONTENT", - "CnttTp": "PROPRIETARY" - } - } - }, - { - "description": "CreditTransferTransactionInformation.\nSet of elements providing information specific to the individual credit transfer(s).\n" - } - ] - } - }, - "required": [ - "GrpHdr", - "CdtTrfTxInf" - ], - "example": { - "GrpHdr": { - "MsgId": 20191113001, - "CreDtTm": "2019-11-13T10:00:00", - "NbOfTxs": 1, - "CtrlSum": 1000, - "InitgPty": { - "Nm": "Initiating Party Name", - "Id": { - "OrgId": { - "Othr": { - "Id": 123456789, - "SchmeNm": { - "Cd": "BBA" - } - } - } - } - }, - "FwdgAgt": { - "FinInstnId": { - "BICFI": "BBBBBBBB" - } - }, - "DbtrAgt": { - "FinInstnId": { - "BICFI": "AAAAAAAA" - } - }, - "CdtrAgt": { - "FinInstnId": { - "BICFI": "CCCCCCCC" - } - } - }, - "CdtTrfTxInf": { - "PmtId": { - "InstrId": 20191113001, - "EndToEndId": 20191113001 - }, - "PmtTpInf": { - "InstrPrty": "NORM", - "CtgyPurp": { - "Cd": "SUPP" - } - }, - "InstrForCdtrAgt": { - "Cd": "/ACC/123456789" - }, - "IntrBkSttlmAmt": { - "Amt": 1000, - "Ccy": "EUR" - }, - "ChrgBr": "SHAR", - "CdtrAgt": { - "FinInstnId": { - "BICFI": "CCCCCCCC" - } - }, - "Cdtr": { - "Nm": "Creditor Name" - }, - "CdtrAcct": { - "Id": { - "IBAN": "BE71096123456769" - } - }, - "RmtInf": { - "Ustrd": "Payment for invoice 12345" - } - } - } - }, - "GenericAccountIdentification1": { - "title": "GenericAccountIdentification1", - "type": "object", - "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" - } - }, - "GenericFinancialIdentification1": { - "title": "GenericFinancialIdentification1", - "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Identification\nUnique and unambiguous identification of a person.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "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" + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Financial institution servicing an account for the creditor.\n" + } + ] } + }, + "required": [ + "Dbtr", + "Cdtr", + "DbtrAgt", + "CdtrAgt", + "InstdAmt" ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "BIC" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" - } - }, - "GenericIdentification3": { - "title": "GenericIdentification3", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "Issr": "BIC" - } - }, - "GenericIdentification30": { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - "GenericOrganisationIdentification1": { - "title": "GenericOrganisationIdentification1", - "type": "object", - "description": "Information that locates and identifies an organisation.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", - "type": "object", - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" - } - ] - }, - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Underlying Customer Credit Transfer\nTBD\n" } ] - } - }, - "anyOf": [ - { - "properties": { - "Cd": {} - } }, - { - "properties": { - "Prtry": {} - } - } - ], - "example": { - "Cd": "BIC" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } - }, - "GenericOrganisationIdentification3": { - "title": "GenericOrganisationIdentification3", - "type": "object", - "description": "Information related to an identification of an organisation.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 - }, - { - "description": "Identification\nIdentification assigned by an institution.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", - "type": "object", - "properties": { - "Cd": { + "IntrBkSttlmAmt": { "allOf": [ { - "title": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "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", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" } ] }, - "Prtry": { + "InstdAmt": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" - } - ] - } - }, - "anyOf": [ - { - "properties": { - "Cd": {} - } - }, - { - "properties": { - "Prtry": {} - } - } - ], - "example": { - "Cd": "BIC" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } - }, - "GenericPersonIdentification1": { - "title": "GenericPersonIdentification1", - "type": "object", - "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Identification\nUnique and unambiguous identification of a person.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalPersonIdentification1Code", - "description": "Specifies the external person identification code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "CCPT" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" - } - }, - "GenericPersonIdentification2": { - "title": "GenericPersonIdentification2", - "type": "object", - "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 + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of 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": "Proprietary\nName of the identification scheme, in a free text form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "CCPT" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" - } - }, - "GetPartiesError_IdentificationVerificationReportV03": { - "title": "GetPartiesError_IdentificationVerificationReportV03", - "type": "object", - "properties": { - "Assgnmt": { - "allOf": [ - { - "title": "IdentificationAssignment3", - "type": "object", - "description": "IdentificationAssignment\nInformation that unambiguously identifies a message, as assigned by the assignor to the assignee.\n", - "properties": { - "MsgId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } }, { - "description": "MessageIdentification\nUnique identification, as assigned by the assigner, to unambiguously identify the message.\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" } ] }, - "CreDtTm": { + "XchgRate": { "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": "BaseOneRate", "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": "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": "CreationDateTime\nDate and time at which the identification assignment was created.\n" + "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" } ] }, - "Assgnr": { + "ChrgBr": { + "title": "ChargeBearerType1Code", + "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR" + ], + "example": "DEBT" + }, + "ChrgsInf": { "allOf": [ { - "title": "Party40Choice", - "description": "Identification of a person, an organisation or a financial institution.\n", + "title": "Charges16", + "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\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" - } + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" ] }, - "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": "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", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\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": "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" } ] - }, - "SchmeNm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -93817,306 +119483,163 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Proprietary\nProprietary identification of the clearing system.\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": "CHIPS" + } + }, + { + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + } + ] + }, + "MmbId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } - }, - "required": [ - "Prtry" ] } + }, + "required": [ + "MmbId" ], "example": { - "Cd": "ADDR" + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "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": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\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": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, 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": 140, + "example": 12345 }, - "AdrLine": { - "title": "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 by which an agent is known and which is usually used to identify that agent\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": [ + "PstlAdr": { + "allOf": [ { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "OrgId": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "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": { + "Cd": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "description": "AddressType2Code\nSpecifies the type 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-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "example": "ADDR" }, { - "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "Othr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "GenericOrganisationIdentification1", + "title": "GenericIdentification30", "type": "object", - "description": "Information that locates and identifies an organisation.\n", + "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", + "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": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "SchmeNm": { + "Issr": { "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "Issr": { + "SchmeNm": { "allOf": [ { "title": "Max35Text", @@ -94127,226 +119650,461 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Id" + "Id", + "Issr" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\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" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, + ], "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } + "Cd": "BIC" } }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\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": [ - "OrgId" - ] + "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": { - "PrvtId": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "PersonIdentification13", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", "properties": { - "DtAndPlcOfBirth": { + "Cd": { "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" + "description": "AddressType2Code\nSpecifies 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": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" - } + "type": "string", + "example": "ADDR" }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "Othr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "GenericPersonIdentification1", + "title": "GenericIdentification30", "type": "object", - "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", + "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", + "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": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "SchmeNm": { + "Issr": { "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" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "Issr": { + "SchmeNm": { "allOf": [ { "title": "Max35Text", @@ -94357,422 +120115,974 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Id" + "Id", + "Issr" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "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" } ] } }, - "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": [ + "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": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "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": "Identification\nUnique and unambiguous way to identify an organisation.\n" + "description": "Code\nCharge type, in a coded form.\n" } ] - }, - "CtryOfRes": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, 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": "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": "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": "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" ] }, - "CtctDtls": { + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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": "Contact4", - "description": "Specifies the details of the contact person.\n", + "title": "OrganisationIdentification39", + "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": { - "allOf": [ - { - "title": "Max35Text", - "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": { + "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": "Responsibility\nRole of a person in an organisation.\n" + "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, - "Dept": { + "LEI": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 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": 70, - "example": 1.2345678901234567e+99 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "GenericOrganisationIdentification3", "type": "object", + "description": "Information related to an identification of an organisation.\n", "properties": { - "ChanlTp": { + "Id": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", + "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": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "Identification\nIdentification assigned by an institution.\n" } ] }, - "Id": { + "SchmeNm": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", + "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": 128, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "ChanlTp" + "Id" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "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 organisation, 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" + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } } }, { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\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" - } - } + "OrgId" + ] }, { - "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": { + "PrvtId": { "allOf": [ { - "title": "FinancialInstitutionIdentification18", + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", "type": "object", - "description": "Information used to identify a financial institution.\n", "properties": { - "BICFI": { + "DtAndPlcOfBirth": { "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" + "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": "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": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, - "ClrSysMmbId": { + "Othr": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "GenericPersonIdentification2", "type": "object", + "description": "Identification of a person.", "properties": { - "ClrSysId": { + "Id": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "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": [ { @@ -94780,15 +121090,15 @@ "Cd": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "title": "ExternalPersonIdentification1Code", + "description": "Specifies the external person 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" } ] } @@ -94810,7 +121120,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -94821,15 +121131,15 @@ } ], "example": { - "Cd": "CHIPS" + "Cd": "CCPT" } }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "MmbId": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -94840,477 +121150,506 @@ "example": 1.234567890123457e+34 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "MmbId" + "Id" ], "example": { - "ClrSysId": { - "Cd": "CHQB" + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" }, - "MmbId": 123456789 + "Issr": "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": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" - } - ] + "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 }, - "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": "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": "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" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "anyOf": [ + "description": "Sets of elements to identify a name of the identification scheme.\n", + "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": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } - ], - "example": { - "Cd": "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\nName of the identification scheme, in a free text form.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Id" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "Cd": 1111 } }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 - }, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 - } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" - } - ] - }, - "BrnchId": { - "allOf": [ - { - "title": "BranchData3", - "type": "object", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "properties": { - "Id": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -95321,463 +121660,474 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - "LEI": { + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "allOf": [ + { + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\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": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" + "description": "Code\nProxy account type, 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 - }, - { - "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" - } + "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\nProxy account type, in a proprietary form.\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": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "EMAIL" + } + }, + { + "description": "Type\nType of the proxy identification.\n" } - }, - "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + ] + }, + "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 }, - "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": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } - } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" }, - { - "description": "Agent\nIdentification of a financial institution.\n" - } - ] + "Id": 123 + } + }, + { + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } - }, - "required": [ - "Agt" ] } - ], + }, "example": { - "Pty": { - "Nm": "Name", - "PstlAdr": { - "Ctry": "US", - "AdrLine": [ - "Line1", - "Line2" - ] - }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - } - } + "Id": { + "IBAN": "BE71096123456769" }, - "Agt": { - "FinInstnId": { - "BICFI": "BUKBGB22" - }, - "BrnchId": { - "Id": 12345, - "Nm": "Oxford Street Branch", - "PstlAdr": { - "Ctry": "GB", - "AdrLine": [ - "1 Oxford Street", - "London", - "UK" - ] - } - } + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 } } }, { - "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n" + "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n" } ] }, - "Assgne": { + "DbtrAgt": { "allOf": [ { - "title": "Party40Choice", - "description": "Identification of a person, an organisation or a financial institution.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "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" - } - ] + "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" }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + { + "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + } + ] + }, + "ClrSysMmbId": { + "allOf": [ + { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", - "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", "type": "string", - "example": "ADDR" + "minLength": 1, + "maxLength": 5, + "example": 12345 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } @@ -95791,67 +122141,15 @@ "Prtry": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } @@ -95862,106 +122160,17 @@ } ], "example": { - "Cd": "ADDR" + "Cd": "CHIPS" } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { + { + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + } + ] + }, + "MmbId": { + "allOf": [ + { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -95969,1290 +122178,918 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + ] } - ] + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } }, - "Id": { - "allOf": [ - { - "title": "Party38Choice", - "description": "Nature or use of the account.\n", + { + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identifier of the financial institution.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", + "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" - ] - } - ], - "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" + ] } + }, + "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": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", - "type": "object", "properties": { - "ChanlTp": { + "Cd": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, - "Id": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 128, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ - "ChanlTp" - ], - "example": { - "ChanlTp": "PHON", - "Id": 1234567890 - } - }, - { - "description": "Other\nContact details in another form.\n" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "BIC" + } }, - "PrefrdMtd": { - "allOf": [ - { - "title": "PreferredContactMethod1Code", - "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", - "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "CELL" - }, - { - "description": "PreferredMethod\nPreferred method used to reach the contact.\n" - } - ] + { + "description": "SchemeName\nName of the identification scheme.\n" } - }, - "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" - } + ] }, - { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - }, - "Id": { - "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Prtry": "DfspId" - } + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + { + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } - } + ] + } + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - { - "description": "Party\nIdentification of a person or an organisation.\n" + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } - ] + } + }, + { + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\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", + "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": "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": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] } + }, + "required": [ + "Cd" ] }, - "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": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "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": "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\nProprietary identification of the clearing system.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\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": [ - "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" - } - ] + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" - } - ] + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length 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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + ] } + }, + "required": [ + "Prtry" ] - }, - "Othr": { - "allOf": [ + } + ], + "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": [ { - "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": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\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" - } + "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", @@ -97263,626 +123100,535 @@ "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 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": "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" + } + ] + }, + "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": "Agent\nIdentification of a financial institution.\n" + ] } - ] - } - }, - "required": [ - "Agt" - ] - } - ], - "example": { - "Pty": { - "Nm": "Name", - "PstlAdr": { - "Ctry": "US", - "AdrLine": [ - "Line1", - "Line2" - ] - }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - } - } - }, - "Agt": { - "FinInstnId": { - "BICFI": "BUKBGB22" - }, - "BrnchId": { - "Id": 12345, - "Nm": "Oxford Street Branch", - "PstlAdr": { - "Ctry": "GB", - "AdrLine": [ - "1 Oxford Street", - "London", - "UK" - ] - } - } - } - } - }, - { - "description": "Assignee\nParty that the identification assignment is assigned to. This is also the receiver of the message.\n" - } - ] - } - }, - "required": [ - "MsgId", - "CreDtTm", - "Assgnr", - "Assgne" - ], - "example": { - "MsgId": 123, - "CreDtTm": "2020-01-01T00:00:00Z", - "Assgnr": { - "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } - } - }, - "Assgne": { - "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } - } - } - } - }, - { - "description": "Assignment\nInformation related to the identification assignment.\n" - } - ] - }, - "Rpt": { - "allOf": [ - { - "title": "VerificationReport4", - "type": "object", - "description": "VerificationReport\nProvides information about the verification of party and/or account identification information.", - "properties": { - "OrgnlId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "OriginalIdentification\nUnique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message.\n" - } - ] - }, - "Vrfctn": { - "allOf": [ - { - "title": "IdentificationVerificationIndicator", - "type": "boolean", - "example": true, - "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n" - }, - { - "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n" - } - ] - }, - "Rsn": { - "allOf": [ - { - "title": "VerificationReason1Choice", - "type": "object", - "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalVerificationReason1Code", - "description": "Specifies the external verification reason code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - { - "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n" + "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" } - }, - "required": [ - "Prtry" ] - } - ], - "example": { - "Cd": "AGNT" - } - }, - { - "description": "Reason\nSpecifies the reason why the verified identification information is incorrect.\n" - } - ] - }, - "OrgnlPtyAndAcctId": { - "allOf": [ - { - "title": "IdentificationInformation4", - "type": "object", - "description": "Information that locates and identifies a specific party or account.\n", - "properties": { - "Pty": { + }, + "BrnchId": { "allOf": [ { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" + } + ] + }, "Nm": { "allOf": [ { @@ -97894,14 +123640,14 @@ "example": 12345 }, { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { - "title": "PostalAddress24", + "title": "PostalAddress27", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -98016,6 +123762,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", @@ -98033,12 +123787,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", @@ -98049,12 +123803,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", @@ -98064,6 +123818,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", @@ -98089,28 +123851,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", @@ -98138,12 +123900,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", @@ -98159,815 +123923,667 @@ "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": [ + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" + } + ] + }, + "Cdtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Contact4", - "description": "Specifies the details of the contact person.\n", - "type": "object", "properties": { - "NmPrfx": { + "Cd": { "allOf": [ { - "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ - "DOCT", - "MADM", - "MISS", - "MIST", - "MIKS" + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" ], "type": "string", - "example": "DOCT" - }, - { - "description": "NamePrefix\nName prefix to be used before the name of the person.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" - } - ] - }, - "PhneNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" - }, - { - "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" - } - ] - }, - "MobNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" - }, - { - "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" - } - ] - }, - "FaxNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" - }, - { - "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" - } - ] - }, - "EmailAdr": { - "allOf": [ - { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 - }, - { - "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" - } - ] - }, - "EmailPurp": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" - } - ] - }, - "JobTitl": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "JobTitle\nTitle of the function.\n" - } - ] - }, - "Rspnsblty": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Responsibility\nRole of a person in an organisation.\n" - } - ] - }, - "Dept": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "example": "ADDR" }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "Othr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "GenericIdentification30", "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "ChanlTp": { + "Id": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 4, + "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, - "Id": { + "Issr": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 128, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "ChanlTp" + "Id", + "Issr" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "Other\nContact details in another form.\n" - } - ] - }, - "PrefrdMtd": { - "allOf": [ - { - "title": "PreferredContactMethod1Code", - "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", - "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "CELL" - }, - { - "description": "PreferredMethod\nPreferred method used to reach the contact.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, - "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" - } - }, - { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - }, - "Id": { - "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Prtry": "DfspId" - } + "required": [ + "Prtry" + ] } + ], + "example": { + "Cd": "ADDR" } }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "Acct": { + "Id": { "allOf": [ { - "title": "CashAccount40", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", "type": "object", - "description": "Provides the details to identify an account.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "AccountIdentification4Choice", - "type": "object", - "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", - "anyOf": [ + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", "properties": { - "IBAN": { + "AnyBIC": { "allOf": [ { - "title": "IBAN2007Identifier", - "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "title": "AnyBICDec2014Identifier", "type": "string", - "example": "FR1420041010050500013M02606", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" }, { - "description": "IBAN\nInternational Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions.\n" + "description": "AnyBIC\nBusiness identification code of the organisation.\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericOrganisationIdentification3", + "type": "object", + "description": "Information related to an identification of an organisation.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + { + "description": "Identification\nIdentification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "IBAN" - ] + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } }, { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + } + ] + } + }, + "required": [ + "OrgId" + ] + }, + { + "properties": { + "PrvtId": { + "allOf": [ + { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", "properties": { + "DtAndPlcOfBirth": { + "allOf": [ + { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "BirthDate\nDate on which a person was born.\n" + } + ] + }, + "PrvcOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ProvinceOfBirth\nProvince where a person was born.\n" + } + ] + }, + "CityOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "CityOfBirth\nCity where a person was born.\n" + } + ] + }, + "CtryOfBirth": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "CountryOfBirth\nCountry where a person was born.\n" + } + ] + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + { + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + } + ] + }, "Othr": { "allOf": [ { - "title": "GenericAccountIdentification1", + "title": "GenericPersonIdentification2", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 + "maxLength": 256, + "example": 256 }, { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { - "title": "AccountSchemeName1Choice", - "type": "object", + "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", + "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, @@ -99007,7 +124623,7 @@ } ], "example": { - "Cd": 1111 + "Cd": "CCPT" } }, { @@ -99037,274 +124653,229 @@ "example": { "Id": 123, "SchmeNm": { - "Cd": "IBAN" + "Cd": "DRLC" }, "Issr": "BIC" } }, { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Othr" - ] + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + }, + { + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } + ] + } + }, + "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": { - "IBAN": "BE71096123456769" - } + "type": "string", + "example": "DOCT" }, { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, - "Tp": { + "Nm": { "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": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "description": "Type\nSpecifies the nature, or use of the account.\n" + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, - "Ccy": { + "PhneNb": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "title": "PhoneNumber", "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { - "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": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, - "Nm": { + "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", @@ -99315,316 +124886,221 @@ "example": 1.2345678901234567e+99 }, { - "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, - "Prxy": { + "Othr": { "allOf": [ { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", "type": "object", "properties": { - "Tp": { + "ChanlTp": { "allOf": [ { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", - "type": "object", - "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": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "Type\nType of the proxy identification.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, - "maxLength": 2048, - "example": 2048 + "maxLength": 128, + "example": 12345 }, { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Id" + "ChanlTp" ], "example": { - "Tp": { - "Cd": "IBAN" - }, - "Id": 123 + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "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": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" - }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 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" } }, { - "description": "Account\nUnambiguous identification of the account of a party.\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" }, - "Agt": { + "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": "BranchAndFinancialInstitutionIdentification6", + "title": "AccountIdentification4Choice", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification18", - "type": "object", - "description": "Information used to identify a financial institution.\n", - "properties": { - "BICFI": { - "allOf": [ - { - "title": "BICFIDec2014Identifier", - "type": "string", - "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - { - "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" - } - ] + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "anyOf": [ + { + "properties": { + "IBAN": { + "allOf": [ + { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "example": "FR1420041010050500013M02606", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, - "ClrSysMmbId": { - "allOf": [ - { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "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": "IBAN\nInternational Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions.\n" + } + ] + } + }, + "required": [ + "IBAN" + ] + }, + { + "properties": { + "Othr": { + "allOf": [ + { + "title": "GenericAccountIdentification1", + "type": "object", + "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 }, - "MmbId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" - } - ] + { + "description": "Identification\nIdentification assigned by an institution.\n" } - }, - "required": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 - } - }, - { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" - }, - { - "description": "LEI\nLegal entity identifier of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + ] }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "SchmeNm": { + "allOf": [ + { + "title": "AccountSchemeName1Choice", "type": "object", - "description": "Choice of formats for the type of address.\n", + "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" } ] } @@ -99638,67 +125114,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" } ] } @@ -99709,106 +125133,17 @@ } ], "example": { - "Cd": "ADDR" + "Cd": 1111 } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -99816,1428 +125151,1439 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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" + } }, - "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" + { + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "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 }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + { + "description": "Code\nProxy account type, in a coded form as published in an external list.\n" + } + ] } + }, + "required": [ + "Cd" ] - } - }, - "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": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" + } + ] + } }, - "Issr": 123 + "required": [ + "Prtry" + ] } + ], + "example": { + "Cd": "EMAIL" } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" + "description": "Type\nType of the proxy identification.\n" } ] }, - "BrnchId": { + "Id": { "allOf": [ { - "title": "BranchData3", + "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": "Information that locates and identifies a specific branch of 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": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": { + "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": "Legal Entity Identifier\nLegal entity identification for the branch 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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "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" } ] - }, - "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 - } + } + }, + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "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": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, - "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": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\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" + ] + }, + "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": "Agent\nFinancial institution servicing an account for a party.\n" + }, + "type": "array" } ] } }, - "required": [ - "Pty" - ], "example": { - "Pty": { - "Id": { - "OrgId": { - "AnyBIC": { - "BICFI": "BICFI" - } - } - }, - "CtryOfRes": "FI" - }, - "Acct": { - "Id": { - "IBAN": "FI2112345600000785" - } + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" }, - "Agt": { - "FinInstnId": { - "BICFI": "BICFI" - } + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" } } }, { - "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n" + "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" } ] }, - "UpdtdPtyAndAcctId": { + "Tax": { "allOf": [ { - "title": "IdentificationInformation4", + "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": "Information that locates and identifies a specific party or account.\n", "properties": { - "Pty": { + "Cdtr": { "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" - } - } - } + "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": "Identification\nUnique and unambiguous way to identify an organisation.\n" + "description": "TaxIdentification\n\nTax identification number of the creditor.\n" } ] }, - "CtryOfRes": { + "RegnId": { "allOf": [ { - "title": "CountryCode", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" + "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, - "CtctDtls": { + "TaxTp": { "allOf": [ { - "title": "Contact4", - "description": "Specifies the details of the contact 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": "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": { - "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": { + "Titl": { "allOf": [ { "title": "Max35Text", @@ -101248,26 +126594,112 @@ "example": 1.234567890123457e+34 }, { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, - "JobTitl": { + "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": "JobTitle\nTitle of the function.\n" + "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] - }, - "Rspnsblty": { + } + }, + "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", @@ -101278,386 +126710,330 @@ "example": 1.234567890123457e+34 }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, - "Dept": { + "Nm": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - { - "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" + "maxLength": 140, + "example": 12345 }, { - "description": "PreferredMethod\nPreferred method used to reach the contact.\n" + "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "Titl": "Mr", + "Nm": "John Doe" } }, { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" + "description": "Authorisation\n\nDetails of the authorised tax paying 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" + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" } } }, { - "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" + "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n" } ] }, - "Acct": { + "AdmstnZone": { "allOf": [ { - "title": "CashAccount40", + "title": "Max35Text", + "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": "Provides the details to identify an account.\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": "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" - } + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\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" } ] }, - "Tp": { + "Ccy": { "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": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "Type\nSpecifies the nature, or use of the account.\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" } ] }, @@ -101838,4187 +127214,3885 @@ ] }, { - "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": "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" } ] }, - "Nm": { + "DbtrSts": { "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": "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": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" } ] }, - "Prxy": { + "FrmsCd": { "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 - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\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": { + "Prd": { "allOf": [ { - "title": "FinancialInstitutionIdentification18", + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\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": { - "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": { + "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" - } - ] - } - }, - "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" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, - "Nm": { + "Tp": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 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": 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 an agent is known and which is usually used to identify that agent.\n" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "PstlAdr": { + "Yr": { "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": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" } } }, { - "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\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": { - "Id": 123, - "CreDtTm": "2013-03-07T16:30:00", - "Assgnr": { - "Id": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" - } - }, - "Assgne": { - "Id": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" - } - } - }, - "Rpt": { - "Id": 123, - "CreDtTm": "2013-03-07T16:30:00", - "RptgPty": { - "Id": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" - } - }, - "RptdPty": { - "Id": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" - } - }, - "RptdDoc": { - "Nb": 123, - "RltdDt": "2013-03-07", - "RltdDtTp": { - "Cd": 123 - } - }, - "Rsn": { - "Cd": 123, - "Prtry": 123 - } - }, - "SplmtryData": { - "PlcAndNm": 123, - "Envlp": 123, - "RltdDt": "2013-03-07", - "RltdDtTp": { - "Cd": 123 - } - } - } - }, - "GetParties_IdentificationVerificationReportV03": { - "title": "GetParties_IdentificationVerificationReportV03", - "type": "object", - "properties": { - "Assgnmt": { - "allOf": [ - { - "title": "IdentificationAssignment3", - "type": "object", - "description": "IdentificationAssignment\nInformation that unambiguously identifies a message, as assigned by the assignor to the assignee.\n", - "properties": { - "MsgId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "MessageIdentification\nUnique identification, as assigned by the assigner, to unambiguously identify the message.\n" - } - ] - }, - "CreDtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "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": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "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": "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", + "TaxblBaseAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", "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": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of 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": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" - } + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" } - }, - "required": [ - "Prtry" ] } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" ], "example": { - "Cd": "ADDR" + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\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", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + } + ] + }, + "Dtls": { + "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", "anyOf": [ { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", "properties": { - "OrgId": { + "Prd": { "allOf": [ { - "title": "OrganisationIdentification29", - "description": "Unique and unambiguous way to identify an organisation.\n", + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\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": { + "FrToDt": { "allOf": [ { - "title": "GenericOrganisationIdentification1", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", "type": "object", - "description": "Information that locates and identifies an organisation.\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 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" - } + "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": "BIC" - }, - "Issr": "BIC" + "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": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" } } }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] - } - }, - "required": [ - "OrgId" - ] - }, - { - "properties": { - "PrvtId": { + }, + "Amt": { "allOf": [ { - "title": "PersonIdentification13", - "description": "Unique and unambiguous way to identify a person.\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": { - "DtAndPlcOfBirth": { + "ActiveOrHistoricCurrencyAndAmount": { "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": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\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" } ] }, - "Othr": { + "Ccy": { "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": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "Amount\n\nUnderlying tax amount related to the specified period.\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 + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } }, - { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "Amt": { + "Amt": 100, + "Ccy": "EUR" } - ] + } }, - "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 + { + "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": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } } - ] - }, - "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": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } }, - { - "description": "Identifier\nCommunication value such as phone number or email address.\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": [ - "ChanlTp" - ], - "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Amt": { + "Amt": 100, + "Ccy": "EUR" } - }, - { - "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" } - ] + }, + "type": "array" } - }, - "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" - } - }, - { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" + ] } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - }, - "Id": { - "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Prtry": "DfspId" - } + }, + "example": { + "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 } } }, - "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": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } - } + ] }, - { - "description": "Party\nIdentification of a person or an organisation.\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": [ - "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" + }, + "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" + } + ] + } }, - { - "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": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" } - ] - }, - "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" - } - ] + }, + { + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + } + ] + }, + "TtlAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + } + ] + }, + "Dtls": { + "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", + "anyOf": [ + { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "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" } }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] - } + { + "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" }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "CHIPS" + { + "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": "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": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } }, - { - "description": "MemberIdentification\nIdentification of a member of a 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": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Amt": { + "Amt": 100, + "Ccy": "EUR" } - }, - { - "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", + }, + { + "items": { + "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" } ] } }, - "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 + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } }, { - "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": "FinancialIdentificationSchemeName1Choice", + "title": "ActiveOrHistoricCurrencyAndAmount", "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": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of 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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" } - }, - "required": [ - "Prtry" ] } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" ], "example": { - "Cd": "BIC" + "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": "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" + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "Amt": { + "Amt": 100, + "Ccy": "EUR" } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "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" - } + "type": "array" + } + ] } }, - { - "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" + "example": { + "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": [ - "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" + "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" } - } + ] } }, - { - "description": "Agent\nIdentification of a financial institution.\n" + "example": { + "Tp": "VAT", + "Ctgy": "A", + "CtgyDtls": "Standard", + "DbtrSts": "Resident", + "CertId": 123456789, + "FrmsCd": 123456789, + "Prd": { + "Yr": 2019, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2019-01-01", + "ToDt": "2019-12-31" + } + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 1000 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 200 + } + }, + "AddtlInf": "VAT applicable" } - ] + }, + "type": "array" } - }, - "required": [ - "Agt" ] } - ], + }, "example": { - "Pty": { - "Nm": "Name", - "PstlAdr": { - "Ctry": "US", - "AdrLine": [ - "Line1", - "Line2" - ] - }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - } - } + "Cdtr": { + "Titl": "Mr", + "Nm": "John Doe" }, - "Agt": { - "FinInstnId": { - "BICFI": "BUKBGB22" + "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 }, - "BrnchId": { - "Id": 12345, - "Nm": "Oxford Street Branch", - "PstlAdr": { - "Ctry": "GB", - "AdrLine": [ - "1 Oxford Street", - "London", - "UK" + "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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + { + "description": "SHA-256 signature of the terms\n" + } + ] + } + }, + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr", + "VrfctnOfTerms" + ], + "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" + } + } + } + } + }, + "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" + } + }, + "ExternalPaymentTransactionStatus1Code": { + "title": "ExternalPaymentTransactionStatus1Code", + "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\"\n}\n\nNOTE: enum enforcement is not apart of the ISO20022 specification, but is added here for FSPIOP mappings.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": "COMM", + "enum": [ + "COMM", + "RESV", + "RECV", + "ABOR" + ] + }, + "ExternalStatusReason1Code": { + "title": "ExternalStatusReason1Code", + "description": "Specifies the external status reason code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "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" + } + }, + "Max105Text": { + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 105, + "example": 12345 + }, + "StatusReasonInformation14b": { + "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": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "Assgne": { + "Id": { "allOf": [ { - "title": "Party40Choice", - "description": "Identification of a person, an organisation or a financial institution.\n", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", "type": "object", "anyOf": [ { "properties": { - "Pty": { + "OrgId": { "allOf": [ { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "properties": { - "Nm": { + "AnyBIC": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "AnyBICDec2014Identifier", "type": "string", - "minLength": 1, - "maxLength": 140, - "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": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, - "PstlAdr": { + "LEI": { "allOf": [ { - "title": "PostalAddress24", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[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 that locates and identifies a specific address, as defined by postal services.\n", + "description": "Information related to an identification of an organisation.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ + "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": [ { - "description": "AddressType2Code\nSpecifies 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": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation 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" } ] - } - }, - "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" - } + "title": "Max35Text", + "description": "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" } ] } }, - "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": [ + "anyOf": [ { - "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" - } + "Cd": {} } }, { - "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 - } - } + "Prtry": {} } - }, - { - "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" + "example": { + "Cd": "BIC" + } }, { - "description": "NamePrefix\nName prefix to be used before the name of the person.\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 - }, - { - "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}$" + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" }, - "EmailAdr": { + "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": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 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": 2048, - "example": 2048 + "format": "date", + "example": "2013-03-07" }, { - "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" + "description": "BirthDate\nDate on which a person was born.\n" } ] }, - "EmailPurp": { + "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", @@ -106029,11 +131103,11 @@ "example": 1.234567890123457e+34 }, { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, - "JobTitl": { + "CityOfBirth": { "allOf": [ { "title": "Max35Text", @@ -106044,307 +131118,1103 @@ "example": 1.234567890123457e+34 }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "CityOfBirth\nCity where a person was born.\n" } ] }, - "Rspnsblty": { + "CtryOfBirth": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "CountryCode", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "description": "CountryOfBirth\nCountry where a person was born.\n" } ] - }, - "Dept": { + } + }, + "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": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "maxLength": 256, + "example": 256 }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Othr": { + "SchmeNm": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\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" + "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" ] }, - "Id": { - "allOf": [ - { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 128, - "example": 12345 - }, - { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "ChanlTp" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Cd": "CCPT" } }, { - "description": "Other\nContact details in another form.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "PrefrdMtd": { + "Issr": { "allOf": [ { - "title": "PreferredContactMethod1Code", - "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "CELL" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "PreferredMethod\nPreferred method used to reach the contact.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" } }, { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an 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" + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - "Id": { - "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Prtry": "DfspId" - } - } + "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 }, - "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": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + }, + { + "description": "Identifier\nCommunication value such as phone number or email address.\n" + } + ] + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + { + "description": "OtherContact\nContact details in another form.\n" + } + ] + }, + "PrefrdMtd": { + "allOf": [ + { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + }, + { + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + } + ] + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + }, + { + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + { + "description": "Originator\nParty that issues the status.\n" + } + ] + }, + "Rsn": { + "allOf": [ + { + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalStatusReason1Code", + "description": "Specifies the external status reason code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nReason for the status, as published in an external reason code list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nReason for the status, in a proprietary form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + { + "description": "Reason\nSpecifies the reason for the status report.\n" + } + ] + }, + "AddtlInf": { + "allOf": [ + { + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 105, + "example": 12345 + }, + { + "description": "AdditionalInformation\nAdditional information about the status report.\n" + } + ] + } + }, + "required": [ + "Rsn" + ], + "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" + } + }, + "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" + } + }, + "PaymentTransaction163b": { + "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}\n\nNOTE: enum enforcement is not apart of the ISO20022 specification, but is added here for FSPIOP mappings.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": "COMM", + "enum": [ + "COMM", + "RESV", + "RECV", + "ABOR" + ] + }, + { + "description": "Specifies the status of the transaction.\n" + } + ] + }, + "StsRsnInf": { + "allOf": [ + { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", + "type": "object", + "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" } }, - { - "description": "Party\nIdentification of a person or an organisation.\n" + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } - }, - "required": [ - "Pty" ] }, - { - "properties": { - "Agt": { - "allOf": [ + "Id": { + "allOf": [ + { + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", + "type": "object", + "anyOf": [ { - "title": "BranchAndFinancialInstitutionIdentification6", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FinInstnId": { + "OrgId": { "allOf": [ { - "title": "FinancialInstitutionIdentification18", + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", - "description": "Information used to identify a financial institution.\n", "properties": { - "BICFI": { + "AnyBIC": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "title": "AnyBICDec2014Identifier", "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", + "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": "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": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, @@ -106358,359 +132228,80 @@ "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" + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, - "PstlAdr": { + "Othr": { "allOf": [ { - "title": "PostalAddress24", + "title": "GenericOrganisationIdentification3", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "description": "Information related to an identification of an organisation.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ + "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": [ { - "description": "AddressType2Code\nSpecifies 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": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation 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" } ] - } - }, - "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" - } + "title": "Max35Text", + "description": "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" } ] } }, - "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" - ] + "Cd": {} + } }, { "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "Prtry": {} + } } ], "example": { @@ -106744,561 +132335,625 @@ "example": { "Id": 123, "SchmeNm": { - "Cd": "IBAN" + "Cd": "BIC" }, "Issr": "BIC" } }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "Other\nUnique identification of an organisation, 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" - }, + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { - "Cd": 123, - "Prtry": 123 + "Cd": "BIC" }, - "Issr": 123 + "Issr": "BIC" } } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] - }, - "BrnchId": { + } + }, + "required": [ + "OrgId" + ] + }, + { + "properties": { + "PrvtId": { "allOf": [ { - "title": "BranchData3", + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", "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": { + "DtAndPlcOfBirth": { "allOf": [ { - "title": "PostalAddress24", + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a 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": [ + "BirthDt": { + "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": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 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": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\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": "BirthDate\nDate on which a person was born.\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 + "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" + } + ] }, - "DstrctNm": { - "title": "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" + } + ] }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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" + } + ] }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\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" + } + ] }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] } }, + "required": [ + "Id" + ], "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "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": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" } }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\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" + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } } }, { - "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": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "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" }, - "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": "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" } - } + ] }, - { - "description": "Agent\nIdentification of a financial institution.\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": [ - "Agt" ] } + }, + "required": [ + "Id" ], "example": { - "Pty": { - "Nm": "Name", - "PstlAdr": { - "Ctry": "US", - "AdrLine": [ - "Line1", - "Line2" - ] - }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - } - } + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" }, - "Agt": { - "FinInstnId": { - "BICFI": "BUKBGB22" + "Id": { + "OrgId": { + "AnyBIC": "BIC" }, - "BrnchId": { - "Id": 12345, - "Nm": "Oxford Street Branch", - "PstlAdr": { - "Ctry": "GB", - "AdrLine": [ - "1 Oxford Street", - "London", - "UK" - ] + "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": "Assignee\nParty that the identification assignment is assigned to. This is also the receiver of the message.\n" - } - ] - } - }, - "required": [ - "MsgId", - "CreDtTm", - "Assgnr", - "Assgne" - ], - "example": { - "MsgId": 123, - "CreDtTm": "2020-01-01T00:00:00Z", - "Assgnr": { - "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } - } - }, - "Assgne": { - "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } - } - } - } - }, - { - "description": "Assignment\nIdentifies the identification assignment.\n" - } - ] - }, - "Rpt": { - "allOf": [ - { - "title": "VerificationReport4", - "type": "object", - "description": "VerificationReport\nProvides information about the verification of party and/or account identification information.", - "properties": { - "OrgnlId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "OriginalIdentification\nUnique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message.\n" - } - ] - }, - "Vrfctn": { - "allOf": [ - { - "title": "IdentificationVerificationIndicator", - "type": "boolean", - "example": true, - "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n" - }, - { - "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n" + "description": "Originator\nParty that issues the status.\n" } ] }, "Rsn": { "allOf": [ { - "title": "VerificationReason1Choice", + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", "type": "object", - "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalVerificationReason1Code", - "description": "Specifies the external verification reason code.", + "title": "ExternalStatusReason1Code", + "description": "Specifies the external status reason code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { - "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n" + "description": "Code\nReason for the status, as published in an external reason code list.\n" } ] } @@ -107320,7 +132975,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n" + "description": "Proprietary\nReason for the status, in a proprietary form.\n" } ] } @@ -107335,21 +132990,416 @@ } }, { - "description": "Reason\nSpecifies the reason why the verified identification information is incorrect.\n" + "description": "Reason\nSpecifies the reason for the status report.\n" } ] }, - "OrgnlPtyAndAcctId": { + "AddtlInf": { "allOf": [ { - "title": "IdentificationInformation4", + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 105, + "example": 12345 + }, + { + "description": "AdditionalInformation\nAdditional information about the status report.\n" + } + ] + } + }, + "required": [ + "Rsn" + ], + "example": { + "Orgtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "SubDepartment", + "StrtNm": "StreetName", + "BldgNb": "BuildingNumber", + "PstCd": "PostCode", + "TwnNm": "TownName", + "CtrySubDvsn": "CountrySubDivision", + "Ctry": "Country" + } + }, + "Rsn": { + "Cd": "AGNT" + }, + "AddtlInf": "AdditionalInformation" + } + }, + { + "description": "Information concerning the reason for the status.\n" + } + ] + }, + "AccptncDtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "Date and time at which the status was accepted.\n" + } + ] + }, + "AcctSvcrRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" + } + ] + }, + "ExctnConf": { + "allOf": [ + { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + { + "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n" + } + ] + }, + "SplmtryData": { + "allOf": [ + { + "title": "SupplementaryData1", + "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "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": "Date\nSpecified date.\n" + } + ] + } + }, + "required": [ + "Dt" + ] + }, + { + "properties": { + "DtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "DateTime\nSpecified date and time.\n" + } + ] + } + }, + "required": [ + "DtTm" + ] + } + ], + "example": { + "DtTm": "2020-01-01T00:00:00Z" + } + }, + { + "description": "Date/time at which the instruction was processed by the specified party.\n" + } + ] + } + }, + "required": [ + "StsRsnInf" + ], + "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" + } + } + }, + "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}\n\nNOTE: enum enforcement is not apart of the ISO20022 specification, but is added here for FSPIOP mappings.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": "COMM", + "enum": [ + "COMM", + "RESV", + "RECV", + "ABOR" + ] + }, + { + "description": "Specifies the status of the transaction.\n" + } + ] + }, + "StsRsnInf": { + "allOf": [ + { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", "type": "object", - "description": "Information that locates and identifies a specific party or account.\n", "properties": { - "Pty": { + "Orgtr": { "allOf": [ { - "title": "PartyIdentification135", + "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "properties": { @@ -107371,7 +133421,7 @@ "PstlAdr": { "allOf": [ { - "title": "PostalAddress24", + "title": "PostalAddress27", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -107486,6 +133536,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", @@ -107503,12 +133561,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", @@ -107519,12 +133577,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", @@ -107534,6 +133592,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", @@ -107559,28 +133625,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", @@ -107608,12 +133674,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", @@ -107626,15 +133694,15 @@ } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { - "title": "Party38Choice", - "description": "Nature or use of the account.\n", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", "type": "object", "anyOf": [ { @@ -107642,7 +133710,7 @@ "OrgId": { "allOf": [ { - "title": "OrganisationIdentification29", + "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "properties": { @@ -107677,22 +133745,22 @@ "Othr": { "allOf": [ { - "title": "GenericOrganisationIdentification1", + "title": "GenericOrganisationIdentification3", "type": "object", - "description": "Information that locates and identifies an organisation.\n", + "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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 }, { - "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" + "description": "Identification\nIdentification assigned by an institution.\n" } ] }, @@ -107815,7 +133883,7 @@ "PrvtId": { "allOf": [ { - "title": "PersonIdentification13", + "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "properties": { @@ -107905,19 +133973,19 @@ "Othr": { "allOf": [ { - "title": "GenericPersonIdentification1", + "title": "GenericPersonIdentification2", "type": "object", - "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", + "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" @@ -108033,7 +134101,7 @@ } }, { - "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } @@ -108056,7 +134124,7 @@ } }, { - "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" + "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, @@ -108070,14 +134138,14 @@ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { - "description": "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": "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": "Contact4", + "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "properties": { @@ -108096,7 +134164,7 @@ "example": "DOCT" }, { - "description": "NamePrefix\nName prefix to be used before the name of the person.\n" + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, @@ -108154,7 +134222,7 @@ } ] }, - "EmailAdr": { + "URLAdr": { "allOf": [ { "title": "Max2048Text", @@ -108164,6 +134232,21 @@ "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" } @@ -108276,15 +134359,15 @@ } }, { - "description": "Other\nContact details in another form.\n" + "description": "OtherContact\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", + "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", @@ -108293,10 +134376,10 @@ "FAXX", "CELL" ], - "example": "CELL" + "example": "MAIL" }, { - "description": "PreferredMethod\nPreferred method used to reach the contact.\n" + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } @@ -108307,11 +134390,12 @@ "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } @@ -108327,269 +134411,957 @@ "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" + "Ctry": "Ctry" }, "Id": { "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Prtry": "DfspId" - } + "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" + } + ] + } + }, + "required": [ + "Rsn" + ], + "example": { + "Orgtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "SubDepartment", + "StrtNm": "StreetName", + "BldgNb": "BuildingNumber", + "PstCd": "PostCode", + "TwnNm": "TownName", + "CtrySubDvsn": "CountrySubDivision", + "Ctry": "Country" + } + }, + "Rsn": { + "Cd": "AGNT" + }, + "AddtlInf": "AdditionalInformation" + } + }, + { + "description": "Information concerning the reason for the status.\n" + } + ] + }, + "AccptncDtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "Date and time at which the status was accepted.\n" + } + ] + }, + "AcctSvcrRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" + } + ] + }, + "ExctnConf": { + "allOf": [ + { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + { + "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n" + } + ] + }, + "SplmtryData": { + "allOf": [ + { + "title": "SupplementaryData1", + "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "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": "Date\nSpecified date.\n" + } + ] + } + }, + "required": [ + "Dt" + ] + }, + { + "properties": { + "DtTm": { + "allOf": [ + { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", + "example": "2013-03-07T14:44:30.000Z" + }, + { + "description": "DateTime\nSpecified date and time.\n" + } + ] + } + }, + "required": [ + "DtTm" + ] + } + ], + "example": { + "DtTm": "2020-01-01T00:00:00Z" + } + }, + { + "description": "Date/time at which the instruction was processed by the specified party.\n" + } + ] + } + }, + "required": [ + "StsRsnInf" + ], + "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", + "TxInfAndSts" + ], + "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" + } + } + }, + "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" + } + }, + "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", + "PmtInstrXpryDtTm" + ], + "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": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "EndToEndId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "TxId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "UETR": { + "allOf": [ + { + "title": "UUIDv4Identifier", + "type": "string", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" + }, + { + "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" + } + ] + } + }, + "required": [ + "TxId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + { + "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" + } + ] + }, + "PmtTpInf": { + "allOf": [ + { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "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" + } + ] } - } - }, - "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": [ + "Prtry" + ] } + ], + "example": { + "Cd": "CASH" } }, { - "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\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" }, - "Acct": { + "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": "CashAccount40", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", - "description": "Provides the details to identify an account.\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": "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": { + "ActiveOrHistoricCurrencyAndAmount": { "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": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{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\nSpecifies the nature, or use of the account.\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" } ] }, @@ -108770,211 +135542,453 @@ ] }, { - "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": "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": "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 a party is known and which is usually used to identify that party.\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" - } - ] + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" } - }, - "required": [ - "Cd" ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] }, - { - "description": "Proprietary\nProxy account type, in a proprietary form.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] } - ] + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - }, - "required": [ - "Prtry" ] } - ], - "example": { - "Cd": "EMAIL" - } - }, - { - "description": "Type\nType of the proxy identification.\n" + }, + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "Id": { - "allOf": [ - { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 - }, - { - "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" - } - ] + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } }, - "required": [ - "Id" - ], "example": { - "Tp": { - "Cd": "IBAN" - }, - "Id": 123 + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "Postal Address\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 - } - } - }, - { - "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": { + "Id": { "allOf": [ { - "title": "FinancialInstitutionIdentification18", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\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": { - "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": [ + "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": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, - "maxLength": 5, - "example": 12345 + "maxLength": 256, + "example": 256 }, { - "description": "Code\nClearing system identification code, 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", @@ -108985,401 +135999,226 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "Issuer\nEntity that assigns the identification.\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" - } + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" - } - ] - } - }, - "required": [ - "Prtry" + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + } ] } - ], + }, "example": { - "Cd": "ADDR" + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + ] } + }, + "required": [ + "OrgId" ] }, - "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": { + "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": { - "Cd": { + "BirthDt": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution 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" + } + ] + }, + "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": [ - "Cd" - ] + "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": { - "Prtry": { + "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", @@ -109390,102 +136229,195 @@ "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": "DRLC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } - ], - "example": { - "Cd": "BIC" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" + ] } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] - } - }, - "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": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + } + ] } + }, + "required": [ + "PrvtId" ] } - }, - "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" + "OrgId": { + "AnyBIC": "BIC" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" + "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, - "BrnchId": { + "CtryOfRes": { "allOf": [ { - "title": "BranchData3", + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" + } + ] + }, + "CtctDtls": { + "allOf": [ + { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", "type": "object", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { - "Id": { + "NmPrfx": { + "allOf": [ + { + "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + { + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PhneNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + } + ] + }, + "MobNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + } + ] + }, + "FaxNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + } + ] + }, + "URLAdr": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + { + "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" + } + ] + }, + "EmailAdr": { + "allOf": [ + { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + { + "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" + } + ] + }, + "EmailPurp": { "allOf": [ { "title": "Max35Text", @@ -109496,398 +136428,190 @@ "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": "Legal Entity Identifier\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": "PostalAddress24", + "title": "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" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + ] }, - "AdrLine": { - "title": "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", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "Postal Address\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, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" } }, { - "description": "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": "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\nFinancial institution servicing an account for a party.\n" - } - ] - } - }, - "required": [ - "Pty" - ], - "example": { - "Pty": { - "Id": { - "OrgId": { - "AnyBIC": { - "BICFI": "BICFI" - } - } - }, - "CtryOfRes": "FI" - }, - "Acct": { - "Id": { - "IBAN": "FI2112345600000785" - } + "description": "Party that owes an amount of money to the (ultimate) creditor.\n" + } + ] }, - "Agt": { - "FinInstnId": { - "BICFI": "BICFI" - } - } - } - }, - { - "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n" - } - ] - }, - "UpdtdPtyAndAcctId": { - "allOf": [ - { - "title": "IdentificationInformation4", - "type": "object", - "description": "Information that locates and identifies a specific party or account.\n", - "properties": { - "Pty": { + "Cdtr": { "allOf": [ { - "title": "PartyIdentification135", + "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "properties": { @@ -109909,7 +136633,7 @@ "PstlAdr": { "allOf": [ { - "title": "PostalAddress24", + "title": "PostalAddress27", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -110024,6 +136748,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", @@ -110041,12 +136773,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", @@ -110057,12 +136789,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", @@ -110072,6 +136804,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", @@ -110097,28 +136837,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", @@ -110146,12 +136886,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", @@ -110164,15 +136906,15 @@ } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { - "title": "Party38Choice", - "description": "Nature or use of the account.\n", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", "type": "object", "anyOf": [ { @@ -110180,7 +136922,7 @@ "OrgId": { "allOf": [ { - "title": "OrganisationIdentification29", + "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "properties": { @@ -110215,22 +136957,22 @@ "Othr": { "allOf": [ { - "title": "GenericOrganisationIdentification1", + "title": "GenericOrganisationIdentification3", "type": "object", - "description": "Information that locates and identifies an organisation.\n", + "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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 }, { - "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" + "description": "Identification\nIdentification assigned by an institution.\n" } ] }, @@ -110353,7 +137095,7 @@ "PrvtId": { "allOf": [ { - "title": "PersonIdentification13", + "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "properties": { @@ -110443,19 +137185,19 @@ "Othr": { "allOf": [ { - "title": "GenericPersonIdentification1", + "title": "GenericPersonIdentification2", "type": "object", - "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", + "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" @@ -110571,7 +137313,7 @@ } }, { - "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } @@ -110594,7 +137336,7 @@ } }, { - "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" + "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, @@ -110608,14 +137350,14 @@ "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { - "description": "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": "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": "Contact4", + "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "properties": { @@ -110634,7 +137376,7 @@ "example": "DOCT" }, { - "description": "NamePrefix\nName prefix to be used before the name of the person.\n" + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, @@ -110692,7 +137434,7 @@ } ] }, - "EmailAdr": { + "URLAdr": { "allOf": [ { "title": "Max2048Text", @@ -110702,6 +137444,21 @@ "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" } @@ -110814,15 +137571,15 @@ } }, { - "description": "Other\nContact details in another form.\n" + "description": "OtherContact\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", + "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", @@ -110831,10 +137588,10 @@ "FAXX", "CELL" ], - "example": "CELL" + "example": "MAIL" }, { - "description": "PreferredMethod\nPreferred method used to reach the contact.\n" + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } @@ -110845,11 +137602,12 @@ "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } @@ -110865,25 +137623,19 @@ "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" + "Ctry": "Ctry" }, "Id": { "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Prtry": "DfspId" - } + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" } } }, @@ -110899,101 +137651,229 @@ } }, { - "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" + "description": "Party to which an amount of money is due.\n" } ] }, - "Acct": { + "DbtrAgt": { "allOf": [ { - "title": "CashAccount40", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", - "description": "Provides the details to identify an account.\n", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "Id": { + "FinInstnId": { "allOf": [ { - "title": "AccountIdentification4Choice", + "title": "FinancialInstitutionIdentification23", "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": "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": [ - "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": [ + "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": "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": { + "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\nIdentification assigned by an institution.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\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" ] }, - "SchmeNm": { - "allOf": [ - { - "title": "AccountSchemeName1Choice", - "type": "object", - "description": "Sets of elements to identify a 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": "ExternalAccountIdentification1Code", - "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 4, + "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -111004,106 +137884,84 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Prtry" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - ], - "example": { - "Cd": 1111 - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Id" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "Cd": "ADDR" } }, - { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" - } - ] - } - }, - "required": [ - "Othr" - ] - } - ], - "example": { - "IBAN": "BE71096123456769" - } - }, - { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" - } - ] - }, - "Tp": { - "allOf": [ - { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", - "type": "object", - "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", + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Code\nAccount type, in a coded form.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -111111,397 +137969,153 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "CACC" - } - }, - { - "description": "Type\nSpecifies the nature, or use of the account.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - { - "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" - } - ] - }, - "Prxy": { - "allOf": [ - { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", - "type": "object", - "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" - ] + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nProxy account type, in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ], + }, "example": { - "Cd": "EMAIL" - } - }, - { - "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" + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "ClrSysMmbId": { + "Othr": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "GenericFinancialIdentification1", "type": "object", + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { - "ClrSysId": { + "Id": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", + "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, - "maxLength": 5, - "example": 12345 + "maxLength": 4, + "example": 1234 }, { - "description": "Code\nClearing system identification code, as published in an external list.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } @@ -111523,7 +138137,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -111534,15 +138148,15 @@ } ], "example": { - "Cd": "CHIPS" + "Cd": "BIC" } }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "MmbId": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -111553,23 +138167,83 @@ "example": 1.234567890123457e+34 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "MmbId" + "Id" ], "example": { - "ClrSysId": { - "Cd": "CHQB" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - "MmbId": 123456789 + "Issr": "BIC" } }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + } + ] + } + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 + }, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 + } + } + }, + { + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + } + ] + }, + "BrnchId": { + "allOf": [ + { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, @@ -111583,7 +138257,7 @@ "example": "529900T8BM49AURSDO55" }, { - "description": "LEI\nLegal entity identifier of the financial institution.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, @@ -111598,14 +138272,14 @@ "example": 12345 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { - "title": "PostalAddress24", + "title": "PostalAddress27", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -111720,6 +138394,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", @@ -111737,12 +138419,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", @@ -111753,12 +138435,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", @@ -111768,6 +138450,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", @@ -111793,28 +138483,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", @@ -111842,12 +138532,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", @@ -111863,50 +138555,113 @@ "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" + } + ] }, - "Othr": { + "ClrSysMmbId": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\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": { + "ClrSysId": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\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": "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" } ] } @@ -111928,7 +138683,7 @@ "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" } ] } @@ -111939,15 +138694,15 @@ } ], "example": { - "Cd": "BIC" + "Cd": "CHIPS" } }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "Issr": { + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -111958,83 +138713,23 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "Id" + "MmbId" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + "ClrSysId": { + "Cd": "CHQB" }, - "Issr": "BIC" + "MmbId": 123456789 } }, { - "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" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, @@ -112048,7 +138743,7 @@ "example": "529900T8BM49AURSDO55" }, { - "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, @@ -112063,7 +138758,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" } ] }, @@ -112325,2692 +139020,1421 @@ } }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } - ] - } - }, - "example": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - }, - { - "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" - } - ] - } - }, - "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - } - }, - { - "description": "Agent\nFinancial institution servicing an account for a party.\n" - } - ] - } - }, - "required": [ - "Pty" - ], - "example": { - "Pty": { - "Id": { - "OrgId": { - "AnyBIC": { - "BICFI": "BICFI" - } - } - }, - "CtryOfRes": "FI" - }, - "Acct": { - "Id": { - "IBAN": "FI2112345600000785" - } - }, - "Agt": { - "FinInstnId": { - "BICFI": "BICFI" - } - } - } - }, - { - "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n" - } - ] - } - }, - "required": [ - "OrgnlId", - "Vrfctn" - ], - "example": { - "OrgnlId": 1.2345678901234568e+33, - "Vrfctn": true, - "OrgnlPtyAndAcctId": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "1234 Elm St", - "BldgNb": 1234, - "PstCd": 12345, - "TwnNm": "Anytown", - "CtrySubDvsn": "CA", - "Ctry": "US" - }, - "Id": { - "OrgId": { - "AnyBIC": "ABCDUS33", - "Othr": { - "Id": 123456789, - "Issr": "ABA" - } - } - } - }, - "UpdtdPtyAndAcctId": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "1234 Elm St", - "BldgNb": 1234, - "PstCd": 12345, - "TwnNm": "Anytown", - "CtrySubDvsn": "CA", - "Ctry": "US" - }, - "Id": { - "OrgId": { - "AnyBIC": "ABCDUS33", - "Othr": { - "Id": 123456789, - "Issr": "ABA" - } - } - } - } - } - }, - { - "description": "Report\nInformation concerning the verification of the identification data for which verification was requested.\n" - } - ] - }, - "SplmtryData": { - "allOf": [ - { - "title": "SupplementaryData1", - "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", - "type": "object", - "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", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Total Interbank Settlement Amount\n" - } - ] - }, - "SttlmInf": { - "allOf": [ - { - "title": "SettlementInstruction15", - "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", - "type": "object", - "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 + ] + }, + "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 local instrument, as published in an external local instrument code list.\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": "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": "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": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\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" - } - ] + "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": [ - "Cd" - ] + } }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "description": "Financial institution servicing an account for the creditor.\n" } - }, - "required": [ - "Prtry" ] } - ], - "example": { - "Cd": "CH03" - } + }, + "required": [ + "Dbtr", + "Cdtr", + "DbtrAgt", + "CdtrAgt", + "InstdAmt" + ] }, { - "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": "Underlying Customer Credit Transfer\nTBD\n" } ] }, - "CtgyPurp": { + "IntrBkSttlmAmt": { "allOf": [ { - "title": "CategoryPurpose1Choice", - "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "title": "ActiveCurrencyAndAmount", "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" - } - ] + "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 } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } + "Ccy": { + "allOf": [ + { + "title": "ActiveCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" } - }, - "required": [ - "Prtry" ] } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" ], "example": { - "Cd": "CASH" + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" } ] - } - }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" - }, - "CtgyPurp": { - "Cd": "CASH" - } - } - }, - { - "description": "Payment Type Information\n" - } - ] - } - }, - "required": [ - "MsgId", - "CreDtTm", - "NbOfTxs", - "SttlmInf" - ], - "example": { - "MsgId": 12345, - "CreDtTm": "2020-01-01T00:00:00Z", - "NbOfTxs": 1, - "TtlIntrBkSttlmAmt": { - "Ccy": "EUR", - "Value": 100 - }, - "SttlmInf": { - "SttlmMtd": "INDA", - "SttlmAcct": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Ccy": "EUR" - }, - "SttlmAcctOwnr": { - "Nm": "Name" - }, - "SttlmAcctSvcr": { - "Nm": "Name" - }, - "SttlmAgt": { - "FinInstnId": { - "BICFI": "BIC" - } - } - }, - "PmtTpInf": { - "InstrPrty": "NORM", - "CtgyPurp": "CASH" - } - } - }, - "GroupHeader120": { - "title": "GroupHeader120", - "description": "Set of characteristics shared by all individual transactions included in the message.\n", - "type": "object", - "properties": { - "MsgId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "MessageIdentification\nDefinition: Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message.\nUsage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period.\n" - } - ] - }, - "CreDtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "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": { - "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": [ + "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": [ { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, 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": "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": [ + "Ccy": { + "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": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" ] }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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": "Currency\nIdentification of the currency in which the account is held.\n" } - ], - "example": { - "Cd": "CH03" - } - }, - { - "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" + ] } - ] + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } }, - "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": [ + { + "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "XchgRate": { + "allOf": [ + { + "title": "BaseOneRate", + "type": "string", + "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", + "example": 0.7, + "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" + }, + { + "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n" + } + ] + }, + "ChrgBr": { + "title": "ChargeBearerType1Code", + "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR" + ], + "example": "DEBT" + }, + "ChrgsInf": { + "allOf": [ + { + "title": "Charges16", + "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n", + "type": "object", + "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": { - "Cd": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", - "maxLength": 4, - "minLength": 1, + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", - "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": "Code\nCategory purpose, as published in an external category purpose code list.\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" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Ccy": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nCategory purpose, in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "CASH" - } - }, - { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" - } - ] - } - }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" - }, - "CtgyPurp": { - "Cd": "CASH" - } - } - } - }, - "required": [ - "SttlmMtd" - ], - "example": { - "SttlmMtd": "INDA", - "PmtTpInf": { - "InstrPrty": "NORM", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CH03" - }, - "CtgyPurp": { - "Cd": "SUPP" - }, - "Cdtr": { - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "AdrLine": "Address", - "Ctry": "CH" - }, - "Id": { - "OrgId": { - "AnyBIC": "BIC", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN", - "Issr": "BIC" - } - } - } - }, - "CtryOfRes": "CH", - "CtctDtls": { - "Nm": "Name", - "PhneNb": 123, - "EmailAdr": null - } - } - } - } - }, - { - "description": "Settlement Information\n" - } - ] - } - }, - "required": [ - "MsgId", - "CreDtTm", - "NbOfTxs", - "SttlmInf" - ], - "example": { - "MsgId": 12345, - "CreDtTm": "2020-01-01T00:00:00Z", - "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", - "NbOfTxs": 1, - "SttlmInf": { - "SttlmMtd": "INDA", - "SttlmAcct": { - "Id": { - "IBAN": 123 - } - }, - "SttlmAcctOwnr": { - "Nm": "John Doe" - }, - "SttlmAcctSvcr": { - "BICFI": 123 - } - } - } - }, - "IBAN2007Identifier": { - "title": "IBAN2007Identifier", - "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", - "type": "string", - "example": "FR1420041010050500013M02606", - "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" - }, - "ISODate": { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - "ISODateTime": { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - "ISOYear": { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", - "type": "string", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 - }, - "IdentificationAssignment3": { - "title": "IdentificationAssignment3", - "type": "object", - "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": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 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", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, - "AdrLine": { - "title": "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": "Currency\nIdentification of the currency in which the account is held.\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": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } }, - "Id": { - "allOf": [ - { - "title": "Party38Choice", - "description": "Nature or use of the account.\n", - "type": "object", - "anyOf": [ + { + "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": { - "OrgId": { + "BICFI": { "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" - } - } + "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": "Organisation\nUnique and unambiguous way to identify an 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" } ] - } - }, - "required": [ - "OrgId" - ] - }, - { - "properties": { - "PrvtId": { + }, + "ClrSysMmbId": { "allOf": [ { - "title": "PersonIdentification13", - "description": "Unique and unambiguous way to identify a person.\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": { - "DtAndPlcOfBirth": { + "ClrSysId": { "allOf": [ { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\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" + "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" ] }, - "CtryOfBirth": { - "allOf": [ - { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - { - "description": "CountryOfBirth\nCountry where a person was born.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nProprietary identification of the clearing system.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" ], "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" + "Cd": "CHIPS" } }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "Othr": { + "MmbId": { "allOf": [ { - "title": "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": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, + "required": [ + "MmbId" + ], "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "ClrSysId": { + "Cd": "CHQB" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } + "MmbId": 123456789 } }, { - "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\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" - } - ] + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, - "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": "LEI\nLegal entity identifier of the financial institution.\n" } - }, - "required": [ - "ChanlTp" - ], - "example": { - "ChanlTp": "PHON", - "Id": 1234567890 - } - }, - { - "description": "Other\nContact details in another form.\n" - } - ] - }, - "PrefrdMtd": { - "allOf": [ - { - "title": "PreferredContactMethod1Code", - "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", - "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "CELL" - }, - { - "description": "PreferredMethod\nPreferred method used to reach the contact.\n" - } - ] - } - }, - "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" - } - }, - { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - }, - "Id": { - "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Prtry": "DfspId" - } - } - } - }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" - } - } - }, - { - "description": "Party\nIdentification of a person or an organisation.\n" - } - ] - } - }, - "required": [ - "Pty" - ] - }, - { - "properties": { - "Agt": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification6", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification18", - "type": "object", - "description": "Information used to identify a financial institution.\n", - "properties": { - "BICFI": { - "allOf": [ - { - "title": "BICFIDec2014Identifier", - "type": "string", - "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" + ] }, - { - "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" - } - ] - }, - "ClrSysMmbId": { - "allOf": [ - { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "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": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], "type": "string", - "minLength": 1, - "maxLength": 5, - "example": 12345 + "example": "ADDR" }, { - "description": "Code\nClearing system identification code, as published in an external list.\n" + "description": "Code\nType of address expressed as a code.\n" } ] } @@ -115024,15 +140448,67 @@ "Prtry": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } @@ -115043,17 +140519,42 @@ } ], "example": { - "Cd": "CHIPS" + "Cd": "ADDR" } }, - { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" - } - ] - }, - "MmbId": { - "allOf": [ - { + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -115061,134 +140562,164 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] - } - }, - "required": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } }, - "MmbId": 123456789 - } - }, - { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" - }, - { - "description": "LEI\nLegal entity identifier of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "Othr": { + "allOf": [ + { + "title": "GenericFinancialIdentification1", "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": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "SchmeNm": { + "allOf": [ + { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "description": "Specifies the name of the identification scheme.\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", + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution 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", @@ -115199,117 +140730,104 @@ "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": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum 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": { + { + "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", @@ -115317,105 +140835,71 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\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", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\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": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, 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": 140, + "example": 12345 }, - "AdrLine": { - "title": "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 by which an agent is known and which is usually used to identify that agent.\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", + "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": "Specifies the name of the identification scheme.\n", + "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { - "title": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution 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" } ] } @@ -115429,15 +140913,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" } ] } @@ -115448,11 +140984,271 @@ } ], "example": { - "Cd": "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": "SchemeName\nName of the identification scheme.\n" + "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n" } ] }, @@ -115477,183 +141273,448 @@ ], "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": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\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": [ + "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" + ] }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of 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": 123 + "required": [ + "Prtry" + ] } + ], + "example": { + "Cd": "ADDR" } }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\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" + } }, - "BrnchId": { - "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": "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": { + "OrgId": { "allOf": [ { - "title": "PostalAddress24", + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\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": [ + "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": { - "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": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", - "example": "ADDR" + "minLength": 1, + "maxLength": 256, + "example": 256 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Identification\nIdentification assigned by an institution.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "SchmeNm": { "allOf": [ { - "title": "GenericIdentification30", + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation 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": { + "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": "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": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -115664,370 +141725,259 @@ "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" + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } ], "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": "BIC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an organisation, 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 + ] } }, "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } } }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, - "example": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - }, - { - "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" - } - ] - } - }, - "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - } - }, - { - "description": "Agent\nIdentification of a financial institution.\n" - } - ] - } - }, - "required": [ - "Agt" - ] - } - ], - "example": { - "Pty": { - "Nm": "Name", - "PstlAdr": { - "Ctry": "US", - "AdrLine": [ - "Line1", - "Line2" - ] - }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - } - } - }, - "Agt": { - "FinInstnId": { - "BICFI": "BUKBGB22" - }, - "BrnchId": { - "Id": 12345, - "Nm": "Oxford Street Branch", - "PstlAdr": { - "Ctry": "GB", - "AdrLine": [ - "1 Oxford Street", - "London", - "UK" - ] - } - } - } - } - }, - { - "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n" - } - ] - }, - "Assgne": { - "allOf": [ - { - "title": "Party40Choice", - "description": "Identification of a person, an organisation or a financial institution.\n", - "type": "object", - "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 + "required": [ + "OrgId" + ] }, { - "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": [ + "PrvtId": { + "allOf": [ { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", "properties": { - "Cd": { + "DtAndPlcOfBirth": { "allOf": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "BirthDate\nDate on which a person was born.\n" + } + ] + }, + "PrvcOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ProvinceOfBirth\nProvince where a person was born.\n" + } + ] + }, + "CityOfBirth": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "CityOfBirth\nCity where a person was born.\n" + } + ] + }, + "CtryOfBirth": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "CountryOfBirth\nCountry where a person was born.\n" + } + ] + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" ], - "type": "string", - "example": "ADDR" + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Othr": { "allOf": [ { - "title": "GenericIdentification30", + "title": "GenericPersonIdentification2", "type": "object", - "description": "Generic scheme identification for a party.\n", + "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + { + "description": "Identification\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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, @@ -116045,129 +141995,194 @@ "description": "Issuer\nEntity that assigns the identification.\n" } ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\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", @@ -116175,7 +142190,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", @@ -116183,7 +142205,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", @@ -116191,844 +142220,237 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { + { + "description": "Responsibility\nRole of a person in an organisation.\n" + } + ] + }, + "Dept": { + "allOf": [ + { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 + }, + { + "description": "Department\nIdentification of a division of a large organisation or building.\n" } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } + ] }, - { - "description": "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" - ] - }, + "Othr": { + "allOf": [ { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", "properties": { - "PrvtId": { + "ChanlTp": { "allOf": [ { - "title": "PersonIdentification13", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "properties": { - "BirthDt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "BirthDate\nDate on which a person was born.\n" - } - ] - }, - "PrvcOfBirth": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "ProvinceOfBirth\nProvince where a person was born.\n" - } - ] - }, - "CityOfBirth": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "CityOfBirth\nCity where a person was born.\n" - } - ] - }, - "CtryOfBirth": { - "allOf": [ - { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - { - "description": "CountryOfBirth\nCountry where a person was born.\n" - } - ] - } - }, - "required": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" - ], - "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" - } - }, - { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" - } - ] - }, - "Othr": { - "allOf": [ - { - "title": "GenericPersonIdentification1", - "type": "object", - "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Identification\nUnique and unambiguous identification of a person.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "type": "object", - "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" + "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": "PreferredMethod\nPreferred method used to reach the contact.\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" } - }, - "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" - } + "PrefrdMtd": { + "allOf": [ + { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + }, + { + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + } + ] } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" } }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "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" } } }, - { - "description": "Party\nIdentification of a person or 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": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\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": [ + "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": [ { - "title": "FinancialInstitutionIdentification18", - "type": "object", - "description": "Information used to identify a financial institution.\n", "properties": { - "BICFI": { + "IBAN": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "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", - "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": "FR1420041010050500013M02606", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-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": "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" } ] - }, - "ClrSysMmbId": { + } + }, + "required": [ + "IBAN" + ] + }, + { + "properties": { + "Othr": { "allOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "title": "GenericAccountIdentification1", "type": "object", + "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { - "ClrSysId": { + "Id": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "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": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\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", "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" } ] } @@ -117050,7 +142472,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } @@ -117061,15 +142483,15 @@ } ], "example": { - "Cd": "CHIPS" + "Cd": 1111 } }, { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "MmbId": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -117080,401 +142502,338 @@ "example": 1.234567890123457e+34 }, { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "MmbId" + "Id" ], "example": { - "ClrSysId": { - "Cd": "CHQB" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - "MmbId": 123456789 + "Issr": "BIC" } }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] - }, - "LEI": { + } + }, + "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": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated 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": "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", - "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\nAccount type, in a coded form.\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\nNature or use of the account in a proprietary form.\n" } ] - }, - "PstlAdr": { - "allOf": [ + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + { + "description": "Type\nSpecifies the nature, or use of the account.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "allOf": [ + { + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", + "type": "object", + "anyOf": [ { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ + "Cd": { + "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": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type 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" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\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": "Code\nProxy account type, in a coded form as published in an external list.\n" } - ], - "example": { - "Cd": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + ] } }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } + "required": [ + "Cd" + ] }, { - "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": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -117485,146 +142844,132 @@ "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" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "EMAIL" + } + }, + { + "description": "Type\nType of the proxy identification.\n" } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 + ] + }, + "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 }, - "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": "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" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + { + "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": "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", + "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" + "minLength": 1, + "maxLength": 5, + "example": 12345 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } @@ -117638,67 +142983,15 @@ "Prtry": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } @@ -117709,106 +143002,17 @@ } ], "example": { - "Cd": "ADDR" + "Cd": "CHIPS" } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { + { + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + } + ] + }, + "MmbId": { + "allOf": [ + { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -117816,547 +143020,354 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + ] } - ] + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + { + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\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" + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": "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": { + "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": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", - "example": "ADDR" + "minLength": 1, + "maxLength": 140, + "example": 12345 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "PstlAdr": { "allOf": [ { - "title": "GenericIdentification30", + "title": "PostalAddress24", "type": "object", - "description": "Generic scheme identification for a party.\n", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Id": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\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": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\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" + } }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\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 }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "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", + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 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" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "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", + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "LEI\nLegal entity identification as an alternate identification for a party.\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": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } }, - "Othr": { - "allOf": [ - { - "title": "GenericOrganisationIdentification1", - "type": "object", - "description": "Information that locates and identifies an organisation.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" - } - ] + { + "description": "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 }, - "SchmeNm": { - "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": "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": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, @@ -118366,7 +143377,14 @@ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { "Prtry": { "allOf": [ { @@ -118383,228 +143401,203 @@ ] } }, - "anyOf": [ - { - "properties": { - "Cd": {} - } - }, - { - "properties": { - "Prtry": {} - } - } - ], - "example": { - "Cd": "BIC" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "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 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] + { + "description": "SchemeName\nName of the identification scheme.\n" } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } + ] }, - { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] } - ] - } - }, - "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" }, - "Issr": "BIC" + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "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 }, - { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } - ] + } + }, + { + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\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" - } - ] + "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 }, - "Othr": { - "allOf": [ - { - "title": "GenericPersonIdentification1", + { + "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": "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", @@ -118615,485 +143608,450 @@ "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" + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "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": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\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": [ - "PrvtId" ] } + }, + "required": [ + "FinInstnId" ], "example": { - "OrgId": { - "AnyBIC": "BIC" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "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" } } } }, { - "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" + "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" } ] }, - "CtctDtls": { + "CdtrAgt": { "allOf": [ { - "title": "Contact4", - "description": "Specifies the details of the contact person.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "NmPrfx": { - "allOf": [ - { - "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", - "enum": [ - "DOCT", - "MADM", - "MISS", - "MIST", - "MIKS" - ], - "type": "string", - "example": "DOCT" - }, - { - "description": "NamePrefix\nName prefix to be used before the name of the person.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" - } - ] - }, - "PhneNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" - }, - { - "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" - } - ] - }, - "MobNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" - }, - { - "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" - } - ] - }, - "FaxNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" - }, - { - "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" - } - ] - }, - "EmailAdr": { - "allOf": [ - { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 - }, - { - "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" - } - ] - }, - "EmailPurp": { - "allOf": [ - { - "title": "Max35Text", - "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": { + "FinInstnId": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "FinancialInstitutionIdentification23", "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "ChanlTp": { + "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": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 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": 4, - "example": 1234 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\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 an agent is known and which is usually used to identify that agent\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", + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", + "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" } ] } @@ -119107,15 +144065,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" } ] } @@ -119126,17 +144136,42 @@ } ], "example": { - "Cd": 1111 + "Cd": "ADDR" } }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -119144,341 +144179,544 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "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": "BIC" - } + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] }, - { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\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": [ - "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": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - { - "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 + "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": "Proprietary\nNature or use of the account in a proprietary form.\n" + "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" } - }, - "required": [ - "Prtry" ] - } - ], - "example": { - "Cd": "CACC" - } - }, - { - "description": "Type\nSpecifies the nature, or use of the account.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - { - "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" - } - ] - }, - "Prxy": { - "allOf": [ - { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", - "type": "object", - "properties": { - "Tp": { + }, + "BrnchId": { "allOf": [ { - "title": "ProxyAccountType1Choice", - "description": "Specifies the type of the proxy account.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalProxyAccountType1Code", - "description": "Specifies the external proxy account type 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": 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": [ - { + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "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", @@ -119486,218 +144724,105 @@ "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" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "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" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "Id" + "FinInstnId" ], "example": { - "Tp": { - "Cd": "IBAN" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Id": 123 + "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": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\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": { + "Cdtr": { "allOf": [ { - "title": "FinancialInstitutionIdentification18", + "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": { - "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": [ { @@ -119709,14 +144834,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": { @@ -119831,6 +144956,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", @@ -119848,12 +144981,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", @@ -119864,12 +144997,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", @@ -119879,6 +145012,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", @@ -119904,22 +145045,30 @@ "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": "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", @@ -119927,62 +145076,603 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies 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" + } + ] }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\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" + } + ] }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "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": { + "EmailPurp": { "allOf": [ { "title": "Max35Text", @@ -119993,72 +145683,26 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, - "SchmeNm": { + "JobTitl": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", - "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": "Max35Text", + "description": "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": "JobTitle\nTitle of the function.\n" } ] }, - "Issr": { + "Rspnsblty": { "allOf": [ { "title": "Max35Text", @@ -120069,1366 +145713,888 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Responsibility\nRole of a person in an organisation.\n" } ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" - } - ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 - }, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 - } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" - } - ] - }, - "BrnchId": { - "allOf": [ - { - "title": "BranchData3", - "type": "object", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" - }, - { - "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "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": [ + "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": [ { - "description": "AddressType2Code\nSpecifies 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": "Max4Text", + "description": "Specifies a 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": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Id": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 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": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 }, { - "description": "Proprietary\nType of address expressed 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": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + ] }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "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": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "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." - } - }, - "InstructionForCreditorAgent3_FX_Quotes": { - "title": "InstructionForCreditorAgent3_Put_FX_Quotes_ID", - "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", - "type": "object", - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalCreditorAgentInstruction1Code", - "description": "Specifies the instruction given by the creditor to the creditor agent.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" - } - ] - }, - "InstrInf": { - "allOf": [ - { - "title": "AmountTypeEnum", - "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", - "type": "string", - "enum": [ - "SEND", - "RECEIVE" - ], - "example": "SEND" - }, - { - "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" - } - ] - } - }, - "example": { - "Cd": "PHOA", - "InstrInf": "Please advise/contact next agent by phone." - } - }, - "InstructionForNextAgent1": { - "title": "InstructionForNextAgent1", - "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n", - "type": "object", - "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 + "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": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" + "description": "Creditor\nParty to which an amount of money is due.\n" } ] }, - "SchmeNm": { + "CdtrAcct": { "allOf": [ { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", + "title": "CashAccount40", "type": "object", + "description": "Provides the details to identify an account.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification code.", + "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", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" } ] }, - "Prtry": { + "Nm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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\nName of the identification scheme, in a free text form.\n" + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "allOf": [ + { + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nProxy account type, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nProxy account type, in a proprietary form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "EMAIL" + } + }, + { + "description": "Type\nType of the proxy identification.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + { + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + }, + { + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, - "anyOf": [ - { - "properties": { - "Cd": {} - } + "example": { + "Id": { + "IBAN": "BE71096123456769" }, - { - "properties": { - "Prtry": {} - } + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 } - ], - "example": { - "Cd": "BIC" } }, { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "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" + "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" } ] }, - "SchmeNm": { + "InstrForCdtrAgt": { "allOf": [ { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", + "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": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification code.", + "title": "ExternalCreditorAgentInstruction1Code", + "description": "Specifies the instruction given by the creditor to the creditor agent.", "type": "string", "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\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" } ] }, - "Prtry": { + "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": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" } ] } }, - "anyOf": [ - { - "properties": { - "Cd": {} - } - }, - { - "properties": { - "Prtry": {} - } - } - ], "example": { - "Cd": "BIC" + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." } }, { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "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" + "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, - "OrgnlUETR": { + "InstrForNxtAgt": { "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": "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": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n" + "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, - "TxSts": { + "Purp": { "allOf": [ { - "title": "ExternalPaymentTransactionStatus1Code", - "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\"\n}\n\nNOTE: enum enforcement is not apart of the ISO20022 specification, but is added here for FSPIOP mappings.\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": "COMM", - "enum": [ - "COMM", - "RESV", - "RECV", - "ABOR" - ] + "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": "Specifies the status of the transaction.\n" + "description": "Purpose\nUnderlying reason for the payment transaction.\n" } ] }, - "StsRsnInf": { + "RgltryRptg": { "allOf": [ { - "title": "StatusReasonInformation14", - "description": "Unsure on description.\n", + "title": "RegulatoryReporting3", + "description": "Information needed due to regulatory and/or statutory requirements.\n", "type": "object", "properties": { - "Orgtr": { + "DbtCdtRptgInd": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\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", + "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": { @@ -121442,4942 +146608,6051 @@ "example": 12345 }, { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n" } ] }, - "PstlAdr": { + "Ctry": { "allOf": [ { - "title": "PostalAddress27", + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or 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": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" ] }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of 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": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" + } + ] + }, + "Inf": { + "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", + "anyOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "items": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "type": "array" + } + ] + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + }, + { + "items": { + "title": "StructuredRegulatoryReporting3", + "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", + "type": "object", + "properties": { + "Tp": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" + } + ] + }, + "Dt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" + } + ] + }, + "Ctry": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + { + "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" + } + ] + }, + "Cd": { + "allOf": [ + { + "title": "Max10Text", + "description": "Specifies a character string with a maximum length of 10 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 10, + "example": 1234567890 + }, + { + "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" + } + ] + }, + "Amt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, - "required": [ - "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" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" + } + ] + }, + "Inf": { + "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", + "anyOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "items": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "type": "array" + } + ] + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + }, + "type": "array" + } + ] + } + }, + "example": { + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + }, + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" + } + } + }, + { + "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" + } + ] + }, + "Tax": { + "allOf": [ + { + "title": "TaxData1", + "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n", + "type": "object", + "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" } - ], - "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 + "Nm": { + "allOf": [ + { + "title": "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": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" + "Titl": "Mr", + "Nm": "John Doe" } }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" + } + ] + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + { + "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" + } + ] + }, + "UltmtDbtr": { + "allOf": [ + { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, - "Id": { + "RegnId": { "allOf": [ { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\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": "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", - "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" - } - ] + "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" } - }, - "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" - } - ] + "Nm": { + "allOf": [ + { + "title": "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" } - }, - "required": [ - "PrvtId" ] } - ], + }, "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } + "Titl": "Mr", + "Nm": "John Doe" } }, { - "description": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" + } + ] + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + { + "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n" + } + ] + }, + "AdmstnZone": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n" + } + ] + }, + "RefNb": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n" + } + ] + }, + "Mtd": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n" + } + ] + }, + "TtlTaxblBaseAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" + } + ] + }, + "TtlTaxAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" + } + ] + }, + "Dt": { + "allOf": [ + { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + { + "description": "Date\n\nDate by which tax is due.\n" + } + ] + }, + "SeqNb": { + "allOf": [ + { + "title": "Number", + "type": "string", + "example": 256, + "pattern": "^(?!0\\d)\\d{1,18}$" + }, + { + "description": "SequenceNumber\n\nSequential number of the tax report.\n" + } + ] + }, + "Rcrd": { + "description": "Record\n\nDetails of the tax record.\n", + "anyOf": [ + { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "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" } ] }, - "CtryOfRes": { + "CertId": { "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": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" } ] }, - "CtctDtls": { + "Ctgy": { "allOf": [ { - "title": "Contact13", - "description": "Specifies the details of the contact 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": "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": { - "NmPrfx": { + "FrToDt": { "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": "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" ], - "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 + "example": { + "FrDt": "2022-01-01", + "ToDt": "2022-12-31" + } }, { - "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, - "EmailAdr": { + "Tp": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 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": 256, - "example": 256 + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" }, { - "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "EmailPurp": { + "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": "EmailPurpose\nPurpose for which an email address may be used.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] - }, - "JobTitl": { + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + { + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + } + ] + }, + "TaxAmt": { + "allOf": [ + { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "PercentageRate", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "example": 1234, + "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, - "Rspnsblty": { + "TaxblBaseAmt": { "allOf": [ { - "title": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, - "Dept": { + "TtlAmt": { "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": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" } ] }, - "Othr": { - "allOf": [ + "Dtls": { + "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", + "anyOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", "type": "object", "properties": { - "ChanlTp": { + "Prd": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", - "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": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, - "Id": { + "Amt": { "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": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ - "ChanlTp" + "Amt" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } } }, { - "description": "OtherContact\nContact details in another form.\n" - } - ] - }, - "PrefrdMtd": { - "allOf": [ - { - "title": "PreferredContactMethod2Code", - "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", - "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "MAIL" - }, - { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" - } - ] - } - }, - "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "URLAdr": "http://www.example.com", - "EmailAdr": "example@example.com" - } - }, - { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry" - }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } - }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" - } - } - }, - { - "description": "Originator\nParty that issues the status.\n" - } - ] - }, - "Rsn": { - "allOf": [ - { - "title": "StatusReason6Choice", - "description": "Specifies the reason for the status.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalStatusReason1Code", - "description": "Specifies the external status reason code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nReason for the status, as published in an external reason code list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nReason for the status, in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "AGNT" - } - }, - { - "description": "Reason\nSpecifies the reason for the status report.\n" - } - ] - }, - "AddtlInf": { - "allOf": [ - { - "title": "Max105Text", - "description": "Specifies a character string with a maximum length of 105 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 105, - "example": 12345 - }, - { - "description": "AdditionalInformation\nAdditional information about the status report.\n" - } - ] - } - }, - "example": { - "Orgtr": { - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "SubDepartment", - "StrtNm": "StreetName", - "BldgNb": "BuildingNumber", - "PstCd": "PostCode", - "TwnNm": "TownName", - "CtrySubDvsn": "CountrySubDivision", - "Ctry": "Country" - } - }, - "Rsn": { - "Cd": "AGNT" - }, - "AddtlInf": "AdditionalInformation" - } - }, - { - "description": "Information concerning the reason for the status.\n" - } - ] - }, - "AccptncDtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "Date and time at which the status was accepted.\n" - } - ] - }, - "AcctSvcrRef": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" - } - ] - }, - "ClrSysRef": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" - } - ] - }, - "ExctnConf": { - "allOf": [ - { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", - "type": "string", - "pattern": "^[A-Za-z0-9-_]{43}$", - "maxLength": 48 - }, - { - "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n" - } - ] - }, - "SplmtryData": { - "allOf": [ - { - "title": "SupplementaryData1", - "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", - "type": "object", - "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": "Date\nSpecified date.\n" - } - ] - } - }, - "required": [ - "Dt" - ] - }, - { - "properties": { - "DtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "DateTime\nSpecified date and time.\n" - } - ] - } - }, - "required": [ - "DtTm" - ] - } - ], - "example": { - "DtTm": "2020-01-01T00:00:00Z" - } - }, - { - "description": "Date/time at which the instruction was processed by the specified party.\n" - } - ] - } - }, - "example": { - "StsId": 12345, - "OrgnlInstrId": 12345, - "OrgnlEndToEndId": 12345, - "OrgnlTxId": 12345, - "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", - "TxSts": "RJCT", - "StsRsnInf": { - "Rsn": "RSN", - "AddtlInf": "ADDITIONAL" - }, - "AccptncDtTm": "2020-01-01T00:00:00Z", - "AcctSvcrRef": "ACCTSVCRREF", - "ClrSysRef": "CLRSYSREF", - "ExctnConf": "1234567890ABCDEF", - "SplmtryData": { - "PlcAndNm": "PLACE", - "Envlp": "ENVELOPE" - } - } - }, - { - "description": "Information concerning the original transactions, to which the status report message refers.\n" - } - ] - }, - "SplmtryData": { - "allOf": [ - { - "title": "SupplementaryData1", - "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", - "type": "object", - "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}\n\nNOTE: enum enforcement is not apart of the ISO20022 specification, but is added here for FSPIOP mappings.\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": "COMM", - "enum": [ - "COMM", - "RESV", - "RECV", - "ABOR" - ] - }, - { - "description": "Specifies the status of the transaction.\n" - } - ] - }, - "StsRsnInf": { - "allOf": [ - { - "title": "StatusReasonInformation14", - "description": "Unsure on description.\n", - "type": "object", - "properties": { - "Orgtr": { - "allOf": [ - { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "properties": { - "Nm": { + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + } + ] + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + "type": "array" + } + ] + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + { + "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" + } + ] + }, + "Tp": { "allOf": [ { - "title": "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": "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": "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": { + "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" } }, - "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": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + } + ] + }, + "TtlAmt": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + { + "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + } + ] + }, + "Dtls": { + "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", + "anyOf": [ + { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length 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": [ + "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": "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", + { + "items": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount.\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": { + "Prd": { "allOf": [ { - "title": "GenericOrganisationIdentification3", + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\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": { + "FrToDt": { "allOf": [ { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", "type": "object", "properties": { - "Cd": { + "FrDt": { "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", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "format": "date", + "example": "2013-03-07" }, { - "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" } ] }, - "Prtry": { + "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": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "ToDate\nEnd date of the range.\n" } ] } }, - "anyOf": [ - { - "properties": { - "Cd": {} - } - }, - { - "properties": { - "Prtry": {} - } - } + "required": [ + "FrDt", + "ToDt" ], "example": { - "Cd": "BIC" + "FrDt": "2022-01-01", + "ToDt": "2022-12-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" + "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, - "CityOfBirth": { + "Tp": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" }, { - "description": "CityOfBirth\nCity where a person was born.\n" + "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, - "CtryOfBirth": { + "Yr": { "allOf": [ { - "title": "CountryCode", + "title": "ISOYear", + "description": "Year represented by YYYY (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" + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 }, { - "description": "CountryOfBirth\nCountry where a person was born.\n" + "description": "Year\n\nYear related to the tax payment.\n" } ] } }, - "required": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" - ], "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } } }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth 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" } ] }, - "Othr": { + "Amt": { "allOf": [ { - "title": "GenericPersonIdentification2", + "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", - "description": "Identification of a person.", + "description": "A number of 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": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "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" - } + "example": 123.45, + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { - "description": "SchemeName\nName of the identification scheme.\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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ - "Id" + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, + "required": [ + "Amt" + ], "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" } - } - } - }, - { - "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" + "Amt": { + "Amt": 100, + "Ccy": "EUR" } - ] + } }, - "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 + "type": "array" } - }, - { - "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" + "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": "PreferredContactMethod\nPreferred method used to reach the contact.\n" - } - ] + "Inf": 12345 + } } }, - "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": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\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" - } + "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" + } + ] } }, - "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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", - "type": "string", - "pattern": "^[A-Za-z0-9-_]{43}$", - "maxLength": 48 - }, - { - "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n" - } - ] - }, - "SplmtryData": { - "allOf": [ - { - "title": "SupplementaryData1", - "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", - "type": "object", - "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": "Date\nSpecified date.\n" - } - ] - } - }, - "required": [ - "Dt" - ] - }, - { - "properties": { - "DtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "DateTime\nSpecified date and time.\n" - } - ] - } - }, - "required": [ - "DtTm" - ] - } - ], - "example": { - "DtTm": "2020-01-01T00:00:00Z" - } - }, - { - "description": "Date/time at which the instruction was processed by the specified party.\n" - } - ] - } - }, - "example": { - "StsId": 12345, - "OrgnlInstrId": 12345, - "OrgnlEndToEndId": 12345, - "OrgnlTxId": 12345, - "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", - "TxSts": "RJCT", - "StsRsnInf": { - "Rsn": "RSN", - "AddtlInf": "ADDITIONAL" - }, - "AccptncDtTm": "2020-01-01T00:00:00Z", - "AcctSvcrRef": "ACCTSVCRREF", - "ClrSysRef": "CLRSYSREF", - "ExctnConf": "1234567890ABCDEF", - "SplmtryData": { - "PlcAndNm": "PLACE", - "Envlp": "ENVELOPE" - } - } - }, - { - "description": "Information concerning the original transactions, to which the status report message refers.\n" - } - ] - }, - "SplmtryData": { - "allOf": [ - { - "title": "SupplementaryData1", - "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", - "type": "object", - "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", - "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" - } - ] + "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" } }, - "anyOf": [ - { - "properties": { - "Cd": {} - } + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 1000 }, - { - "properties": { - "Prtry": {} - } + "TtlAmt": { + "Ccy": "EUR", + "Amt": 200 } - ], - "example": { - "Cd": "BIC" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "VAT applicable" } - ] + }, + "type": "array" } - }, - "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" + "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" } - } + ] }, - { - "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", + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "Cryptographically signed terms\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" - } - ] + "anyOf": [ + { + "properties": { + "IlpV4PrepPacket": { + "allOf": [ + { + "title": "hexBinary", + "type": "string", + "example": 4660, + "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, - "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": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\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": [ + "IlpV4PrepPacket" ] }, - "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" - } - ] + { + "properties": { + "Sh256Sgntr": { + "allOf": [ + { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "SHA-256 signature of the terms\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": [ + "Sh256Sgntr" ] } - }, + ], "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr", + "VrfctnOfTerms" + ], + "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" }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } + "FinInstnId": { + "BICFI": "BICFI" } + }, + "Tp": { + "Cd": "SHAR" } }, - { - "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" - } - ] + "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": [ - "PrvtId" ] } + }, + "required": [ + "GrpHdr", + "CdtTrfTxInf" ], "example": { - "OrgId": { - "AnyBIC": "BIC" + "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 + } + } }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "CdtTrfTxInf": { + "PmtId": { + "InstrId": 123, + "EndToEndId": 123 + }, + "PmtTpInf": { + "InstrPrty": "NORM" + }, + "InstdAmt": { + "Amt": 123, + "Ccy": "EUR" + }, + "ChrgBr": "SHAR", + "CdtrAgt": { + "FinInstnId": { + "BICFI": 123 + } + }, + "Cdtr": { + "Nm": "John Doe" + }, + "CdtrAcct": { + "Id": { + "IBAN": 123 + } + }, + "RmtInf": { + "Ustrd": "Test" } } } }, - "Party40Choice": { - "title": "Party40Choice", - "description": "Identification of a person, an organisation or a financial institution.\n", + "StatusReasonInformation14": { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", "type": "object", - "anyOf": [ - { - "properties": { - "Pty": { - "allOf": [ - { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "properties": { - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] + "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 }, - "Id": { - "allOf": [ - { - "title": "Party38Choice", - "description": "Nature or use of the account.\n", + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", + "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" - } - ] - }, - "CtryOfRes": { - "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 + }, + "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, - { - "description": "CountryOfResidence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } }, - "CtctDtls": { - "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": "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": { + "OrgId": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "OrganisationIdentification39", + "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" } ] - } - }, - "required": [ - "ChanlTp" - ], - "example": { - "ChanlTp": "PHON", - "Id": 1234567890 - } - }, - { - "description": "Other\nContact details in another form.\n" - } - ] - }, - "PrefrdMtd": { - "allOf": [ - { - "title": "PreferredContactMethod1Code", - "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", - "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "CELL" - }, - { - "description": "PreferredMethod\nPreferred method used to reach the contact.\n" - } - ] - } - }, - "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" - } - }, - { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - }, - "Id": { - "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Prtry": "DfspId" - } - } - } - }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" - } - } - }, - { - "description": "Party\nIdentification of a person or an organisation.\n" - } - ] - } - }, - "required": [ - "Pty" - ] - }, - { - "properties": { - "Agt": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification6", - "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification18", - "type": "object", - "description": "Information used to identify a financial institution.\n", - "properties": { - "BICFI": { - "allOf": [ - { - "title": "BICFIDec2014Identifier", - "type": "string", - "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - { - "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" - } - ] - }, - "ClrSysMmbId": { - "allOf": [ - { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", - "properties": { - "ClrSysId": { + }, + "Othr": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "title": "GenericOrganisationIdentification3", "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": "Information related to an identification of an organisation.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + { + "description": "Identification\nIdentification assigned by an institution.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "SchmeNm": { + "allOf": [ + { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "anyOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "properties": { + "Cd": {} + } }, { - "description": "Proprietary\nProprietary identification of the clearing system.\n" + "properties": { + "Prtry": {} + } } - ] + ], + "example": { + "Cd": "BIC" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" } - }, - "required": [ - "Prtry" ] } + }, + "required": [ + "Id" ], "example": { - "Cd": "CHIPS" + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" } }, { - "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": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "MmbId" - ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "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" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 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": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] - }, - "PstlAdr": { + } + }, + "required": [ + "OrgId" + ] + }, + { + "properties": { + "PrvtId": { "allOf": [ { - "title": "PostalAddress24", + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a 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": [ + "DtAndPlcOfBirth": { + "allOf": [ { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", "properties": { - "Cd": { + "BirthDt": { "allOf": [ { - "description": "AddressType2Code\nSpecifies 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", + "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", - "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": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ - "Cd" - ] + "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": { - "Prtry": { + "Id": { "allOf": [ { - "title": "GenericIdentification30", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + { + "description": "Identification\nUnique and unambiguous identification of a person.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "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" ] }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum 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": "CCPT" } }, { - "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": "DRLC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of a person, 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 + ] + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "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": 35, - "example": 1.234567890123457e+34 + "maxLength": 4, + "example": 1234 }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + { + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, 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": 128, + "example": 12345 }, - "AdrLine": { - "title": "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": "Identifier\nCommunication value such as phone number or email address.\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": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } }, - "Othr": { - "allOf": [ - { - "title": "GenericFinancialIdentification1", + { + "description": "OtherContact\nContact details in another form.\n" + } + ] + }, + "PrefrdMtd": { + "allOf": [ + { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + }, + { + "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + } + ] + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + }, + { + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + { + "description": "Originator\nParty that issues the status.\n" + } + ] + }, + "Rsn": { + "allOf": [ + { + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalStatusReason1Code", + "description": "Specifies the external status reason code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nReason for the status, as published in an external reason code list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nReason for the status, in a proprietary form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + { + "description": "Reason\nSpecifies the reason for the status report.\n" + } + ] + }, + "AddtlInf": { + "allOf": [ + { + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 105, + "example": 12345 + }, + { + "description": "AdditionalInformation\nAdditional information about the status report.\n" + } + ] + } + }, + "example": { + "Orgtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "SubDepartment", + "StrtNm": "StreetName", + "BldgNb": "BuildingNumber", + "PstCd": "PostCode", + "TwnNm": "TownName", + "CtrySubDvsn": "CountrySubDivision", + "Ctry": "Country" + } + }, + "Rsn": { + "Cd": "AGNT" + }, + "AddtlInf": "AdditionalInformation" + } + }, + "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}\n\nNOTE: enum enforcement is not apart of the ISO20022 specification, but is added here for FSPIOP mappings.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": "COMM", + "enum": [ + "COMM", + "RESV", + "RECV", + "ABOR" + ] + }, + { + "description": "Specifies the status of the transaction.\n" + } + ] + }, + "StsRsnInf": { + "allOf": [ + { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", + "type": "object", + "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": "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": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\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": "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", @@ -126388,133 +152663,76 @@ "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": "BIC" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "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": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, - { - "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", + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", @@ -126522,89 +152740,262 @@ "maxLength": 140, "example": 12345 }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } }, - "PstlAdr": { - "allOf": [ + { + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", + "type": "object", + "anyOf": [ { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "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" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "LEI": { "allOf": [ { - "title": "GenericIdentification30", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "GenericOrganisationIdentification3", "type": "object", - "description": "Generic scheme identification for a party.\n", + "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "minLength": 1, + "maxLength": 256, + "example": 256 }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "Identification\nIdentification assigned by an institution.\n" } ] }, - "Issr": { + "SchmeNm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + }, + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "SchmeNm": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -126615,781 +153006,425 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Id", - "Issr" + "Id" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] - } - }, - "example": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - }, - { - "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" - } - ] - } - }, - "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - } - }, - { - "description": "Agent\nIdentification of a financial institution.\n" - } - ] - } - }, - "required": [ - "Agt" - ] - } - ], - "example": { - "Pty": { - "Nm": "Name", - "PstlAdr": { - "Ctry": "US", - "AdrLine": [ - "Line1", - "Line2" - ] - }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - } - } - }, - "Agt": { - "FinInstnId": { - "BICFI": "BUKBGB22" - }, - "BrnchId": { - "Id": 12345, - "Nm": "Oxford Street Branch", - "PstlAdr": { - "Ctry": "GB", - "AdrLine": [ - "1 Oxford Street", - "London", - "UK" - ] - } - } - } - } - }, - "Party52Choice": { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", - "properties": { - "AnyBIC": { - "allOf": [ - { - "title": "AnyBICDec2014Identifier", - "type": "string", - "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - { - "description": "AnyBIC\nBusiness identification code of the organisation.\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" - }, - { - "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" - } - ] - }, - "Othr": { - "allOf": [ - { - "title": "GenericOrganisationIdentification3", - "type": "object", - "description": "Information related to an identification of an organisation.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 - }, - { - "description": "Identification\nIdentification assigned by an institution.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", - "type": "object", - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" - } - ] - }, - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\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 + "required": [ + "OrgId" + ] }, { - "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 + "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\nName of the identification scheme, in a coded form as published in an external list.\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" + } + ] } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "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": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\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": "CCPT" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" + }, + "required": [ + "PrvtId" + ] } - ] - }, - "Issr": { - "allOf": [ - { - "title": "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": "Issuer\nEntity that assigns the identification.\n" + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" + } }, - "Issr": "BIC" - } + { + "description": "Identification\nUnique and unambiguous identification of a party.\n" + } + ] }, - { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" - } - ] - } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } - } - }, - { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" - } - ] - } - }, - "required": [ - "PrvtId" - ] - } - ], - "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } - } - }, - "PartyIdentification135": { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "properties": { - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { + "CtryOfRes": { "allOf": [ { - "description": "AddressType2Code\nSpecifies 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": "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": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a 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", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "example": "DOCT" }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, - "Issr": { + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PhneNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + } + ] + }, + "MobNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + } + ] + }, + "FaxNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + } + ] + }, + "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", @@ -127400,11 +153435,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", @@ -127415,720 +153450,533 @@ "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" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "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" - } - ] + "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 }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "Responsibility\nRole of a person in 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" - } - } - }, - { - "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" - } - ] + "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 }, - "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": "Department\nIdentification of a division of a large organisation or building.\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": [ + "Othr": { + "allOf": [ + { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "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": "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": "CCPT" - } + ] }, - { - "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": "DRLC" - }, - "Issr": "BIC" - } + ] }, - { - "description": "Other\nUnique identification of a person, 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": { + "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } } } }, + "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" + ] + }, { - "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\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\nReason for the status, in a proprietary form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "AGNT" + } + }, + { + "description": "Reason\nSpecifies the reason for the status report.\n" + } + ] + }, + "AddtlInf": { + "allOf": [ + { + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 105, + "example": 12345 + }, + { + "description": "AdditionalInformation\nAdditional information about the status report.\n" } - }, - "required": [ - "PrvtId" ] } - ], + }, "example": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + "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": "Identification\nUnique and unambiguous way to identify an organisation.\n" + "description": "Information concerning the reason for the status.\n" } ] }, - "CtryOfRes": { + "AccptncDtTm": { "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": "Date and time at which the status was accepted.\n" } ] }, - "CtctDtls": { + "AcctSvcrRef": { "allOf": [ { - "title": "Contact4", - "description": "Specifies the details of the contact 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": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" + } + ] + }, + "ExctnConf": { + "allOf": [ + { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + { + "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n" + } + ] + }, + "SplmtryData": { + "allOf": [ + { + "title": "SupplementaryData1", + "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", "type": "object", "properties": { - "NmPrfx": { + "PlcAndNm": { "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": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", "type": "string", - "example": "DOCT" + "minLength": 1, + "maxLength": 350, + "example": 350 }, { - "description": "NamePrefix\nName prefix to be used before the name of the person.\n" + "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" } ] }, - "Nm": { + "Envlp": { "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": "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": "Name\nName by which a party is known and which is usually used to identify that party.\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" } ] - }, - "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" + } + }, + "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" ] }, - "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" + { + "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" ] - }, - "FaxNb": { + } + ], + "example": { + "DtTm": "2020-01-01T00:00:00Z" + } + }, + { + "description": "Date/time at which the instruction was processed by the specified party.\n" + } + ] + } + }, + "required": [ + "ExctnConf", + "PrcgDt", + "TxSts" + ], + "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" + } + } + }, + "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": "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": "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" } ] }, - "EmailAdr": { + "CreDtTm": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 + "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": "EmailAddress\nAddress for electronic mail (e-mail).\n" + "description": "CreationDateTime\nDate and time at which the message was created.\n" } ] - }, - "EmailPurp": { + } + }, + "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", @@ -128139,11 +153987,11 @@ "example": 1.234567890123457e+34 }, { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + "description": "Unique identification, as assigned by the original sending party, to unambiguously identify the status report.\n" } ] }, - "JobTitl": { + "OrgnlInstrId": { "allOf": [ { "title": "Max35Text", @@ -128154,11 +154002,11 @@ "example": 1.234567890123457e+34 }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original instruction.\n\n(FSPIOP equivalent: transactionRequestId)\n" } ] }, - "Rspnsblty": { + "OrgnlEndToEndId": { "allOf": [ { "title": "Max35Text", @@ -128169,684 +154017,319 @@ "example": 1.234567890123457e+34 }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "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" } ] }, - "Dept": { + "OrgnlTxId": { "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": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original transaction.\n\n(FSPIOP equivalent: quoteId)\n" } ] }, - "Othr": { + "OrgnlUETR": { "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 - } + "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": "Other\nContact details in another form.\n" + "description": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n" } ] }, - "PrefrdMtd": { + "TxSts": { "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": "ExternalPaymentTransactionStatus1Code", + "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\"\n}\n\nNOTE: enum enforcement is not apart of the ISO20022 specification, but is added here for FSPIOP mappings.\n", "type": "string", + "minLength": 1, + "maxLength": 4, + "example": "COMM", "enum": [ - "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" + "COMM", + "RESV", + "RECV", + "ABOR" ] }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\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": "Specifies the status of the transaction.\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": "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" - } - ] + "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 }, - "SchmeNm": { - "allOf": [ - { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "properties": { - "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" - } - ] - } - }, + "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { - "Cd": {} - } + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, { "properties": { - "Prtry": {} - } + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } ], "example": { - "Cd": "BIC" + "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": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, - { - "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", + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", - "format": "date", - "example": "2013-03-07" + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "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", + "SubDept": { + "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": "ProvinceOfBirth\nProvince where a person was born.\n" - } - ] - }, - "CityOfBirth": { - "allOf": [ - { + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "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", @@ -128854,127 +154337,825 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "CityOfBirth\nCity where a person was born.\n" - } - ] - }, - "CtryOfBirth": { - "allOf": [ - { + "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or 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" + "AdrLine": { + "title": "Max70Text", + "description": "Specifies 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": [ - "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": [ + "Id": { + "allOf": [ + { + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\n", + "type": "object", + "anyOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 + "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" + } + ] }, - { - "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": [ + "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": "ExternalPersonIdentification1Code", - "description": "Specifies the external person identification code.", + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 128, + "example": 12345 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Prtry" - ] + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + { + "description": "OtherContact\nContact details in another form.\n" } - ], - "example": { - "Cd": "CCPT" - } + ] + }, + "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": "SchemeName\nName of the identification scheme.\n" + "description": "Code\nReason for the status, as published in an external reason code list.\n" } ] - }, - "Issr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -128985,210 +155166,82 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nReason for the status, in a proprietary 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": { + "Cd": "AGNT" + } + }, + { + "description": "Reason\nSpecifies the reason for the status report.\n" } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + ] + }, + "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 }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } + { + "description": "AdditionalInformation\nAdditional information about the status report.\n" } + ] + } + }, + "example": { + "Orgtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "SubDepartment", + "StrtNm": "StreetName", + "BldgNb": "BuildingNumber", + "PstCd": "PostCode", + "TwnNm": "TownName", + "CtrySubDvsn": "CountrySubDivision", + "Ctry": "Country" } }, - { - "description": "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 + "Rsn": { + "Cd": "AGNT" + }, + "AddtlInf": "AdditionalInformation" + } }, { - "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" + "description": "Information concerning the reason for the status.\n" } ] }, - "EmailPurp": { + "AccptncDtTm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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": "EmailPurpose\nPurpose for which an email address may be used.\n" + "description": "Date and time at which the status was accepted.\n" } ] }, - "JobTitl": { + "AcctSvcrRef": { "allOf": [ { "title": "Max35Text", @@ -129199,11 +155252,11 @@ "example": 1.234567890123457e+34 }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" } ] }, - "Rspnsblty": { + "ClrSysRef": { "allOf": [ { "title": "Max35Text", @@ -129214,236 +155267,250 @@ "example": 1.234567890123457e+34 }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" } ] }, - "Dept": { + "ExctnConf": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n" } ] }, - "Othr": { + "SplmtryData": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "SupplementaryData1", + "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", "type": "object", "properties": { - "ChanlTp": { + "PlcAndNm": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", + "title": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 350, + "example": 350 }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" } ] }, - "Id": { + "Envlp": { "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": "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": "Identifier\nCommunication value such as phone number or email address.\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" } ] } }, "required": [ - "ChanlTp" + "Envlp" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } } }, { - "description": "OtherContact\nContact details in another form.\n" + "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" } ] }, - "PrefrdMtd": { + "PrcgDt": { "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" + "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": "MAIL" + "example": { + "DtTm": "2020-01-01T00:00:00Z" + } }, { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "Date/time at which the instruction was processed by the specified party.\n" } ] } }, + "required": [ + "ExctnConf", + "PrcgDt", + "TxSts" + ], "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" + "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": "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": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" - }, - { - "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + "description": "Information concerning the original transactions, to which the status report message refers.\n" } ] }, - "ClrSysRef": { + "SplmtryData": { "allOf": [ { - "title": "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": "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": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" + "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" } ] } }, "required": [ - "TxId" + "GrpHdr", + "TxInfAndSts" ], "example": { - "InstrId": "INSTRUCTIONID", - "EndToEndId": "ENDTOENDID", - "TxId": "TRANSACTIONID", - "UETR": "123e4567-e89b-12d3-a456-426614174000", - "ClrSysRef": "CLRSYSREF" + "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" + } + } + } } }, - "PaymentTransaction163": { + "PaymentTransaction163patch": { "title": "PaymentTransaction163", "description": "Provides further details on the original transactions, to which the status report message refers.\n", "type": "object", @@ -130673,6 +156740,9 @@ ] } }, + "required": [ + "Rsn" + ], "example": { "Orgtr": { "Nm": "Name", @@ -130729,423 +156799,234 @@ ] }, "ClrSysRef": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" - } - ] - }, - "ExctnConf": { - "allOf": [ - { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", - "type": "string", - "pattern": "^[A-Za-z0-9-_]{43}$", - "maxLength": 48 - }, - { - "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n" - } - ] - }, - "SplmtryData": { - "allOf": [ - { - "title": "SupplementaryData1", - "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", - "type": "object", - "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": "Date\nSpecified date.\n" - } - ] - } - }, - "required": [ - "Dt" - ] - }, - { - "properties": { - "DtTm": { - "allOf": [ - { - "title": "ISODateTime", - "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", - "type": "string", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", - "example": "2013-03-07T14:44:30.000Z" - }, - { - "description": "DateTime\nSpecified date and time.\n" - } - ] - } - }, - "required": [ - "DtTm" - ] - } - ], - "example": { - "DtTm": "2020-01-01T00:00:00Z" - } - }, - { - "description": "Date/time at which the instruction was processed by the specified party.\n" - } - ] - } - }, - "example": { - "StsId": 12345, - "OrgnlInstrId": 12345, - "OrgnlEndToEndId": 12345, - "OrgnlTxId": 12345, - "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", - "TxSts": "RJCT", - "StsRsnInf": { - "Rsn": "RSN", - "AddtlInf": "ADDITIONAL" - }, - "AccptncDtTm": "2020-01-01T00:00:00Z", - "AcctSvcrRef": "ACCTSVCRREF", - "ClrSysRef": "CLRSYSREF", - "ExctnConf": "1234567890ABCDEF", - "SplmtryData": { - "PlcAndNm": "PLACE", - "Envlp": "ENVELOPE" - } - } - }, - "PaymentTypeInformation28": { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", - "type": "object", - "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" - } + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" + "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" } ] }, - "LclInstrm": { + "ExctnConf": { "allOf": [ { - "title": "LocalInstrument2Choice", + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + { + "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n" + } + ] + }, + "SplmtryData": { + "allOf": [ + { + "title": "SupplementaryData1", + "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", "type": "object", - "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": { + "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": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - } - ] + "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": [ - "Prtry" ] } + }, + "required": [ + "Envlp" ], "example": { - "Cd": "CH03" + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } } }, { - "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": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" } ] }, - "CtgyPurp": { + "PrcgDt": { "allOf": [ { - "title": "CategoryPurpose1Choice", - "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\n", "type": "object", "anyOf": [ { "properties": { - "Cd": { + "Dt": { "allOf": [ { - "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", - "maxLength": 4, - "minLength": 1, + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation 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": 1234 + "format": "date", + "example": "2013-03-07" }, { - "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" + "description": "Date\nSpecified date.\n" } ] } }, "required": [ - "Cd" + "Dt" ] }, { "properties": { - "Prtry": { + "DtTm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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": "Proprietary\nCategory purpose, in a proprietary form.\n" + "description": "DateTime\nSpecified date and time.\n" } ] } }, "required": [ - "Prtry" + "DtTm" ] } ], "example": { - "Cd": "CASH" + "DtTm": "2020-01-01T00:00:00Z" } }, { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "description": "Date/time at which the instruction was processed by the specified party.\n" } ] } }, + "required": [ + "PrcgDt", + "TxSts" + ], "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" }, - "CtgyPurp": { - "Cd": "CASH" + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" } } }, - "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", + "PacsStatus_FIToFIPaymentStatusReportV15patch": { + "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": { - "DtAndPlcOfBirth": { + "GrpHdr": { "allOf": [ { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", + "title": "GroupHeader120", + "description": "Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", "properties": { - "BirthDt": { + "MsgId": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. 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": "BirthDate\nDate on which a person was born.\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" } ] }, - "PrvcOfBirth": { + "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", @@ -131156,11 +157037,11 @@ "example": 1.234567890123457e+34 }, { - "description": "ProvinceOfBirth\nProvince where a person was born.\n" + "description": "Unique identification, as assigned by the original sending party, to unambiguously identify the status report.\n" } ] }, - "CityOfBirth": { + "OrgnlInstrId": { "allOf": [ { "title": "Max35Text", @@ -131171,50 +157052,26 @@ "example": 1.234567890123457e+34 }, { - "description": "CityOfBirth\nCity where a person was born.\n" + "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original instruction.\n\n(FSPIOP equivalent: transactionRequestId)\n" } ] }, - "CtryOfBirth": { + "OrgnlEndToEndId": { "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": "CountryOfBirth\nCountry where a person was born.\n" + "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" } ] - } - }, - "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": { + }, + "OrgnlTxId": { "allOf": [ { "title": "Max35Text", @@ -131225,1337 +157082,1873 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original transaction.\n\n(FSPIOP equivalent: quoteId)\n" } ] }, - "SchmeNm": { + "OrgnlUETR": { "allOf": [ { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", + "title": "UUIDv4Identifier", + "type": "string", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" + }, + { + "description": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n" + } + ] + }, + "TxSts": { + "allOf": [ + { + "title": "ExternalPaymentTransactionStatus1Code", + "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\"\n}\n\nNOTE: enum enforcement is not apart of the ISO20022 specification, but is added here for FSPIOP mappings.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": "COMM", + "enum": [ + "COMM", + "RESV", + "RECV", + "ABOR" + ] + }, + { + "description": "Specifies the status of the transaction.\n" + } + ] + }, + "StsRsnInf": { + "allOf": [ + { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalPersonIdentification1Code", - "description": "Specifies the external person identification code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "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" + ] + }, + { + "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": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "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": { + "allOf": [ + { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or 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": "Proprietary\nName of the identification scheme, in a free text form.\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": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "CCPT" - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" - } - ] - } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } - } - }, - "PersonIdentification18": { - "title": "PersonIdentification18", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "properties": { - "BirthDt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "BirthDate\nDate on which a person was born.\n" - } - ] - }, - "PrvcOfBirth": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "ProvinceOfBirth\nProvince where a person was born.\n" - } - ] - }, - "CityOfBirth": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "CityOfBirth\nCity where a person was born.\n" - } - ] - }, - "CtryOfBirth": { - "allOf": [ - { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - { - "description": "CountryOfBirth\nCountry where a person was born.\n" - } - ] - } - }, - "required": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" - ], - "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" - } - }, - { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" - } - ] - }, - "Othr": { - "allOf": [ - { - "title": "GenericPersonIdentification2", - "type": "object", - "description": "Identification of a person.", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 - }, - { - "description": "Identification\nUnique and unambiguous identification of a person.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalPersonIdentification1Code", - "description": "Specifies the external person identification code.", - "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\nName of the identification scheme, in a coded form as published in an external list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "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\nName of the identification scheme, in a free text 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" } - ] - } - }, - "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 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "Originator\nParty that issues the status.\n" } ] }, - "SchmeNm": { + "Rsn": { "allOf": [ { - "title": "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": "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Reason\nSpecifies the reason for the status report.\n" } ] - } - }, - "required": [ - "Id", - "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": { + }, + "AddtlInf": { + "allOf": [ + { + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 105, + "example": 12345 + }, + { + "description": "AdditionalInformation\nAdditional information about the status report.\n" + } + ] + } + }, + "required": [ + "Rsn" + ], + "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": [ { - "description": "AddressType2Code\nSpecifies 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": "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", - "example": "ADDR" + "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": "Code\nType of address expressed as a code.\n" + "description": "Date and time at which the status was accepted.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "AcctSvcrRef": { "allOf": [ { - "title": "GenericIdentification30", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" + } + ] + }, + "ExctnConf": { + "allOf": [ + { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + { + "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n" + } + ] + }, + "SplmtryData": { + "allOf": [ + { + "title": "SupplementaryData1", + "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", "type": "object", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { + "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": "Issuer\nEntity that assigns the identification.\n" + "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" } ] }, - "SchmeNm": { + "Envlp": { "allOf": [ { - "title": "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": "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": "SchemeName\nShort textual description of the scheme.\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" } ] } }, "required": [ - "Id", - "Issr" + "Envlp" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } } }, { - "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": "Code\nProxy account type, in a coded form as published in an external list.\n" - } - ] + "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ + "PrcgDt": { + "allOf": [ + { + "title": "StatusReason6Choice", + "description": "Specifies the reason for the status.\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": { + "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" + ] }, { - "description": "Proprietary\nProxy account type, in a proprietary form.\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" + } + ] + } + }, + "required": [ + "DtTm" + ] } - ] + ], + "example": { + "DtTm": "2020-01-01T00:00:00Z" + } + }, + { + "description": "Date/time at which the instruction was processed by the specified party.\n" } - }, - "required": [ - "Prtry" ] } + }, + "required": [ + "PrcgDt", + "TxSts" ], "example": { - "Cd": "EMAIL" + "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": "Type\nType of the proxy identification.\n" + "description": "Information concerning the original transactions, to which the status report message refers.\n" } ] }, - "Id": { + "SplmtryData": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 + "title": "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": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" } ] } }, "required": [ - "Id" + "GrpHdr", + "TxInfAndSts" ], "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" - } - ] + "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" } - }, - "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" - ] - } + "AmountTypeEnum": { + "title": "AmountTypeEnum", + "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", + "type": "string", + "enum": [ + "SEND", + "RECEIVE" ], - "example": { - "Cd": "CH03" - } + "example": "SEND" }, - "RegulatoryAuthority2": { - "title": "RegulatoryAuthority2", - "description": "Information about an entity requiring the regulatory reporting information.\n", + "InstructionForCreditorAgent3_FX_Quotes": { + "title": "InstructionForCreditorAgent3_Put_FX_Quotes_ID", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", "type": "object", "properties": { - "Nm": { + "Cd": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "ExternalCreditorAgentInstruction1Code", + "description": "Specifies the instruction given by the creditor to the creditor agent.", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 4, + "example": 1234 }, { - "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n" + "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" } ] }, - "Ctry": { + "InstrInf": { "allOf": [ { - "title": "CountryCode", + "title": "AmountTypeEnum", + "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + "enum": [ + "SEND", + "RECEIVE" + ], + "example": "SEND" }, { - "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n" + "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { - "Nm": "Swiss National Bank", - "Ctry": "CH" + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." } }, - "RegulatoryReporting3": { - "title": "RegulatoryReporting3", - "description": "Information needed due to regulatory and/or statutory requirements.\n", + "CreditTransferTransaction68_FX_Quotes": { + "title": "CreditTransferTransaction68_FX_Quotes", + "description": "Provides further details specific to the individual transaction(s) included in the message.\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": { + "PmtId": { "allOf": [ { - "title": "RegulatoryAuthority2", - "description": "Information about an entity requiring the regulatory reporting information.\n", + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", "type": "object", "properties": { - "Nm": { + "InstrId": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "ULIDIdentifier", "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { - "description": "Name\n\nName of the entity requiring the regulatory reporting information.\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\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, - "Ctry": { + "EndToEndId": { "allOf": [ { - "title": "CountryCode", + "title": "ULIDIdentifier", "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, 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": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { - "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\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\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "TxId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "UETR": { + "allOf": [ + { + "title": "UUIDv4Identifier", + "type": "string", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" + }, + { + "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" } ] } }, + "required": [ + "TxId" + ], "example": { - "Nm": "Swiss National Bank", - "Ctry": "CH" + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" } }, { - "description": "Authority\n\nEntity requiring the regulatory reporting information.\n" + "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\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": [ + "PmtTpInf": { + "allOf": [ { - "title": "StructuredRegulatoryReporting3", - "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", "type": "object", "properties": { - "Tp": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalServiceLevel1Code", + "description": "Specifies the external service level code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } }, { - "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" + "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, - "Dt": { + "LclInstrm": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 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": "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": "Date\n\nDate related to the specified type of regulatory reporting details.\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" } ] }, - "Ctry": { + "CtgyPurp": { "allOf": [ { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, 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": "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": "Country\n\nCountry related to the specified type of regulatory reporting details.\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" }, - "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" - } - ] + "LclInstrm": { + "Cd": "CORE" }, - "Amt": { + "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", @@ -132752,1209 +159145,2185 @@ ] }, { - "description": "Currency\nIdentification of the currency in which the account is held.\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": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 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": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "Id" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "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": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" + "description": "Party that owes an amount of money to the (ultimate) creditor.\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 - }, + "Cdtr": { + "allOf": [ { - "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})$" + "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 + } }, - { - "description": "Amount of 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": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + }, + { + "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" + } + } } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" - } - ] - }, - "Inf": { - "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", - "anyOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "items": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "type": "array" - } - ] - } - }, - "example": { - "Tp": "T1", - "Dt": "2018-01-01", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 - }, - "Inf": 12345 - } - }, - "type": "array" - } - ] - } - }, - "example": { - "DbtCdtRptgInd": "CRED", - "Authrty": { - "Nm": "Swiss National Bank", - "Ctry": "CH" - }, - "Dtls": { - "Cd": "A1", - "Inf": "Mandatory regulatory information" - } - } - }, - "RegulatoryReportingType1Code": { - "title": "RegulatoryReportingType1Code", - "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n", - "type": "string", - "enum": [ - "CRED", - "DEBT", - "BOTH" - ], - "example": "BOTH" - }, - "ServiceLevel8Choice": { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "SEPA" - } - }, - "SettlementInstruction15": { - "title": "SettlementInstruction15", - "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", - "type": "object", - "properties": { - "SttlmMtd": { - "title": "SettlementMethod1Code", - "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n", - "type": "string", - "enum": [ - "INDA", - "INGA", - "COVE", - "CLRG" - ], - "example": "CLRG" - }, - "PmtTpInf": { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", - "type": "object", - "properties": { - "InstrPrty": { - "title": "Priority2Code", - "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", - "type": "string", - "enum": [ - "HIGH", - "NORM" - ], - "example": "HIGH" - }, - "ClrChanl": { - "title": "ClearingChannel2Code", - "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", - "type": "string", - "enum": [ - "RTGS", - "RTNS", - "MPNS", - "BOOK" - ], - "example": "RTGS" - }, - "SvcLvl": { - "allOf": [ - { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "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" + "description": "Identification\nUnique and unambiguous identification of a party.\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": { + }, + "CtryOfRes": { "allOf": [ { - "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", - "maxLength": 4, - "minLength": 1, + "title": "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" + "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": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nCategory purpose, in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "CASH" - } - }, - { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" - } - ] - } - }, - "example": { - "InstrPrty": "NORM", - "ClrChanl": "RTGS", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CORE" - }, - "CtgyPurp": { - "Cd": "CASH" - } - } - } - }, - "required": [ - "SttlmMtd" - ], - "example": { - "SttlmMtd": "INDA", - "PmtTpInf": { - "InstrPrty": "NORM", - "SvcLvl": { - "Cd": "SEPA" - }, - "LclInstrm": { - "Cd": "CH03" - }, - "CtgyPurp": { - "Cd": "SUPP" - }, - "Cdtr": { - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "AdrLine": "Address", - "Ctry": "CH" - }, - "Id": { - "OrgId": { - "AnyBIC": "BIC", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN", - "Issr": "BIC" - } - } - } - }, - "CtryOfRes": "CH", - "CtctDtls": { - "Nm": "Name", - "PhneNb": 123, - "EmailAdr": null - } - } - } - } - }, - "SettlementMethod1Code": { - "title": "SettlementMethod1Code", - "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n", - "type": "string", - "enum": [ - "INDA", - "INGA", - "COVE", - "CLRG" - ], - "example": "CLRG" - }, - "StatusReason6Choice": { - "title": "StatusReason6Choice", - "description": "Specifies the reason for the status.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalStatusReason1Code", - "description": "Specifies the external status reason code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nReason for the status, as published in an external reason code list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nReason for the status, in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "AGNT" - } - }, - "StatusReasonInformation14": { - "title": "StatusReasonInformation14", - "description": "Unsure on description.\n", - "type": "object", - "properties": { - "Orgtr": { - "allOf": [ - { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "properties": { - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress27", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { + "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", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PhneNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + } + ] + }, + "MobNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + } + ] + }, + "FaxNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + } + ] + }, + "URLAdr": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + { + "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" + } + ] + }, + "EmailAdr": { + "allOf": [ + { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + { + "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" + } + ] + }, + "EmailPurp": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + } + ] + }, + "JobTitl": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "JobTitle\nTitle of the function.\n" + } + ] + }, + "Rspnsblty": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Responsibility\nRole of a person in an organisation.\n" + } + ] + }, + "Dept": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Department\nIdentification of a division of a large organisation or building.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", "type": "object", - "description": "Generic scheme identification for a party.\n", "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { + "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": "Issuer\nEntity that assigns the identification.\n" + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, - "SchmeNm": { + "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": "SchemeName\nShort textual description of the scheme.\n" + "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ - "Id", - "Issr" + "ChanlTp" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "ChanlTp": "PHON", + "Id": 1234567890 } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\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": [ - "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" } - ], - "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": [ + "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": [ { @@ -133966,233 +161335,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", @@ -134203,2247 +161487,2484 @@ "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" + ] } + }, + "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 }, - "Issr": { - "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": "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" + ], + "example": { + "Cd": "BIC" + } }, - "Issr": "BIC" - } + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] }, - { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] } - ] - } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 + }, + "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 }, - { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\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": [ - "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" + "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": "Originator\nParty that issues the status.\n" - } - ] - }, - "Rsn": { - "allOf": [ - { - "title": "StatusReason6Choice", - "description": "Specifies the reason for the status.\n", - "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalStatusReason1Code", - "description": "Specifies the external status reason code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nReason for the status, as published in an external reason code list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nReason for the status, in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "AGNT" - } - }, - { - "description": "Reason\nSpecifies the reason for the status report.\n" - } - ] - }, - "AddtlInf": { - "allOf": [ - { - "title": "Max105Text", - "description": "Specifies a character string with a maximum length of 105 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 105, - "example": 12345 - }, - { - "description": "AdditionalInformation\nAdditional information about the status report.\n" - } - ] - } - }, - "example": { - "Orgtr": { - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "SubDepartment", - "StrtNm": "StreetName", - "BldgNb": "BuildingNumber", - "PstCd": "PostCode", - "TwnNm": "TownName", - "CtrySubDvsn": "CountrySubDivision", - "Ctry": "Country" - } - }, - "Rsn": { - "Cd": "AGNT" - }, - "AddtlInf": "AdditionalInformation" - } - }, - "StructuredRegulatoryReporting3": { - "title": "StructuredRegulatoryReporting3", - "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", - "type": "object", - "properties": { - "Tp": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" - } - ] - }, - "Dt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" - } - ] - }, - "Ctry": { - "allOf": [ - { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - { - "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" - } - ] - }, - "Cd": { - "allOf": [ - { - "title": "Max10Text", - "description": "Specifies a character string with a maximum length of 10 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 10, - "example": 1234567890 - }, - { - "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" - } - ] - }, - "Amt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveOrHistoricCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", - "type": "string", - "example": 123.45, - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" - }, - { - "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" - } - ] - }, - "Inf": { - "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", - "anyOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "items": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "type": "array" - } - ] - } - }, - "example": { - "Tp": "T1", - "Dt": "2018-01-01", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 - }, - "Inf": 12345 - } - }, - "SupplementaryData1": { - "title": "SupplementaryData1", - "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", - "type": "object", - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" - } - ] - }, - "TtlAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveOrHistoricCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", - "type": "string", - "example": 123.45, - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" + }, + "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": "Amount of 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 debtor.\n" } ] }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" - } - ] - }, - "Dtls": { - "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", - "anyOf": [ - { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", - "type": "object", - "properties": { - "Prd": { + "CdtrAgt": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FrToDt": { + "FinInstnId": { "allOf": [ { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", + "title": "FinancialInstitutionIdentification23", "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "FrDt": { + "BICFI": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. 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": "BICFIDec2014Identifier", "type": "string", - "format": "date", - "example": "2013-03-07" + "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": "FromDate\nStart date of the range.\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" } ] }, - "ToDt": { + "ClrSysMmbId": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. 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": "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", - "format": "date", - "example": "2013-03-07" + "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": "ToDate\nEnd date of the range.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, - "required": [ - "FrDt", - "ToDt" - ], "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "FinInstnId" ], "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "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 + "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": "TaxType\n\nType of tax payer.\n" + "description": "Financial institution servicing an account for the creditor.\n" } ] } }, - "example": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT" - } + "required": [ + "Dbtr", + "Cdtr", + "DbtrAgt", + "CdtrAgt", + "InstdAmt" + ] }, { - "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" + "description": "Underlying Customer Credit Transfer\nTBD\n" } ] }, - "Dbtr": { + "IntrBkSttlmAmt": { "allOf": [ { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\n", + "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": { - "TaxId": { + "ActiveCurrencyAndAmount": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "TaxIdentification\n\nTax identification number of the debtor.\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 } ] }, - "RegnId": { + "Ccy": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ActiveCurrencyCode", "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] - }, - "TaxTp": { + } + }, + "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": "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": "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": "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", @@ -136454,7 +163975,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" } ] }, @@ -136469,215 +164004,565 @@ "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" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, + "required": [ + "FinInstnId" + ], "example": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT", - "Authstn": { - "Titl": "Mr", - "Nm": "John Doe" + "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\n\nParty on the debit side of the transaction to which the tax applies.\n" + "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" } ] }, - "UltmtDbtr": { + "DbtrAcct": { "allOf": [ { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\n", + "title": "CashAccount40", "type": "object", + "description": "Provides the details to identify an account.\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": { + "Id": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "anyOf": [ + { + "properties": { + "IBAN": { + "allOf": [ + { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "example": "FR1420041010050500013M02606", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" + }, + { + "description": "IBAN\nInternational Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions.\n" + } + ] + } + }, + "required": [ + "IBAN" + ] + }, + { + "properties": { + "Othr": { + "allOf": [ + { + "title": "GenericAccountIdentification1", + "type": "object", + "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + { + "description": "Identification\nIdentification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + } + ] + } + }, + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } }, { - "description": "TaxType\n\nType of tax payer.\n" + "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, - "Authstn": { + "Tp": { "allOf": [ { - "title": "TaxAuthorisation1", - "description": "Details of an authorised tax paying party.\n", + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\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" + "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": { - "allOf": [ - { - "title": "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": { - "Titl": "Mr", - "Nm": "John Doe" + "Cd": "CACC" } }, { - "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": "Type\nSpecifies the nature, or use of the account.\n" } ] }, @@ -136858,5520 +164743,8815 @@ ] }, { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" } ] - } - }, - "required": [ - "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": { + }, + "Nm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 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": 70, + "example": 1.2345678901234567e+99 }, { - "description": "Amount of 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 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" } ] }, - "Ccy": { + "Prxy": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } } }, { - "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" - } - ] - }, - "Dt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "Date\n\nDate by which tax is due.\n" + "description": "DebtorAccount\nAccount used to process a payment.\n" } ] }, - "SeqNb": { + "DbtrAgt": { "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", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\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": { + "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" } ] }, - "TaxAmt": { + "BrnchId": { "allOf": [ { - "title": "TaxAmount3", - "description": "Information on the amount of the tax record.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "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 branch of a financial institution.\n" } ] }, - "TaxblBaseAmt": { + "LEI": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[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": "A number 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": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\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": "Currency\nIdentification of the currency in which the account is held.\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": [ - "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": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" + } + ] + }, + "CdtrAgt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "description": "Information used to identify a financial institution.\n", + "properties": { + "BICFI": { + "allOf": [ + { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, - "TtlAmt": { + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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" + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "Dtls": { - "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", - "anyOf": [ + "LEI": { + "allOf": [ { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identifier of the financial institution.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "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": { + "Cd": { "allOf": [ { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\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": { - "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" - } - ] - } - }, - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "Prtry" + ] } - ] - } - }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + ], + "example": { + "Cd": "ADDR" } }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "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" - } - ] + "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" + } + ] + } }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } + "required": [ + "Cd" + ] }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "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": "Amount\n\nUnderlying tax amount related to the specified period.\n" + ], + "example": { + "Cd": "BIC" } - ] - } + }, + { + "description": "SchemeName\nName of the identification scheme.\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" } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } + ] } }, - "type": "array" + "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": { - "Rate": 0, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 0 + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 0 + "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" }, - "Dtls": { - "Tp": "T1", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 }, - "Inf": 12345 + "Issr": 123 } } }, { - "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "Tp": { + "BrnchId": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Type\n\nHigh level code to identify the type of tax details.\n" - } - ] - } - }, - "example": { - "Tp": "VAT", - "Ctgy": "A", - "CtgyDtls": "Standard", - "DbtrSts": "Resident", - "CertId": 123456789, - "FrmsCd": 123456789, - "Prd": { - "Yr": 2019, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2019-01-01", - "ToDt": "2019-12-31" - } - }, - "TaxAmt": { - "Rate": 0.2, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 1000 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 200 - } - }, - "AddtlInf": "VAT applicable" - } - }, - { - "items": { - "title": "TaxRecord3", - "description": "Set of elements used to define the tax record.\n", - "type": "object", - "properties": { - "AddtlInf": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "AdditionalInformation\n\nFurther details of the tax record.\n" - } - ] - }, - "CertId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" - } - ] - }, - "Ctgy": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" - } - ] - }, - "CtgyDtls": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" - } - ] - }, - "DbtrSts": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" - } - ] - }, - "FrmsCd": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" - } - ] - }, - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "properties": { - "FrDt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "FromDate\nStart date of the range.\n" - } - ] - }, - "ToDt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "ToDate\nEnd date of the range.\n" - } - ] - } - }, - "required": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" - } - }, - { - "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" - } - ] - }, - "Tp": { - "allOf": [ - { - "title": "TaxRecordPeriod1Code", - "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", - "type": "string", - "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" - }, - { - "description": "Type\n\nIdentification of the period related to the tax payment.\n" - } - ] - }, - "Yr": { - "allOf": [ - { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", - "type": "string", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 - }, - { - "description": "Year\n\nYear related to the tax payment.\n" - } - ] - } - }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - } - }, - { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" - } - ] - }, - "TaxAmt": { - "allOf": [ - { - "title": "TaxAmount3", - "description": "Information on the amount of the tax record.\n", - "type": "object", - "properties": { - "Rate": { - "allOf": [ - { - "title": "PercentageRate", - "type": "string", - "example": 1234, - "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" - }, - { - "description": "Rate\n\nRate used to calculate the tax.\n" - } - ] - }, - "TaxblBaseAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveOrHistoricCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", - "type": "string", - "example": 123.45, - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" - }, - { - "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" - } - ] - }, - "TtlAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveOrHistoricCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", - "type": "string", - "example": 123.45, - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" - }, - { - "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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": "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" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\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" - } - ] - }, - "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" + } + ] + }, + "Cdtr": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "description": "Information used to identify a financial institution.\n", + "properties": { + "BICFI": { + "allOf": [ + { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + } + ] + }, + "ClrSysMmbId": { + "allOf": [ + { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 }, - "required": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + { + "description": "Code\nClearing system identification code, 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 - }, - { - "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" - } + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + ], + "example": { + "Cd": "CHIPS" } - ] - }, - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + }, + { + "description": "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" + } + ] + } }, - { - "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": "Amount\n\nUnderlying tax amount related to the specified period.\n" - } - ] + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" } }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } }, - { - "items": { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", - "type": "object", - "properties": { - "Prd": { - "allOf": [ + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "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": [ { - "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", + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", "type": "string", - "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "Type\n\nIdentification of the period related to the tax payment.\n" + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - }, - "Yr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Year\n\nYear related to the tax payment.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + "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": "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "Identification\nIdentification assigned by an institution.\n" } ] }, - "Amt": { + "SchmeNm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "AccountSchemeName1Choice", "type": "object", - "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveOrHistoricCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", - "type": "string", - "example": 123.45, - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" - }, - { - "description": "Amount of 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": "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" ] }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\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": "Currency\nIdentification of the currency in which the account is held.\n" } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Cd": 1111 } }, { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Amt" + "Id" ], "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } + "Issr": "BIC" } }, - "type": "array" - } - ] - } - }, - "example": { - "Rate": 0, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 0 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 0 + { + "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + } + ] + } }, - "Dtls": { - "Tp": "T1", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 - }, - "Inf": 12345 - } + "required": [ + "Othr" + ] } - }, - { - "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": { + "IBAN": "BE71096123456769" } - ] - } - }, - "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" + }, + { + "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } - }, - "TaxAmt": { - "Rate": 0.2, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 1000 + ] + }, + "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" + } }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 200 + { + "description": "Type\nSpecifies the nature, or use of the account.\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 - } - } - }, - "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": { + ] + }, + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" } ] }, "Nm": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, { - "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "allOf": [ + { + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nProxy account type, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nProxy account type, in a proprietary form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "EMAIL" + } + }, + { + "description": "Type\nType of the proxy identification.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + { + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + }, + { + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { - "Titl": "Mr", - "Nm": "John Doe" + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } } }, { - "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" + "description": "CreditorAccount\nAccount to which a credit entry is made.\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": { + }, + "InstrForCdtrAgt": { "allOf": [ { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", + "title": "InstructionForCreditorAgent3_Put_FX_Quotes_ID", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", "type": "object", "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", + "title": "ExternalCreditorAgentInstruction1Code", + "description": "Specifies the instruction given by the creditor to the creditor agent.", "type": "string", - "format": "date", - "example": "2013-03-07" + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "description": "FromDate\nStart date of the range.\n" + "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" } ] }, - "ToDt": { + "InstrInf": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. 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": "AmountTypeEnum", + "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", "type": "string", - "format": "date", - "example": "2013-03-07" + "enum": [ + "SEND", + "RECEIVE" + ], + "example": "SEND" }, { - "description": "ToDate\nEnd date of the range.\n" + "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" } ] } }, - "required": [ - "FrDt", - "ToDt" - ], "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." } }, { - "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" + "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, - "Tp": { + "Purp": { "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": "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": "HLF1" + "example": { + "Cd": "CH03" + } }, { - "description": "Type\n\nIdentification of the period related to the tax payment.\n" + "description": "Purpose\nUnderlying reason for the payment transaction.\n" } ] }, - "Yr": { + "VrfctnOfTerms": { "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 + "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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + { + "description": "SHA-256 signature of the terms\n" + } + ] + } + }, + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } }, { - "description": "Year\n\nYear related to the tax payment.\n" + "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" } ] } }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "UndrlygCstmrCdtTrf", + "Dbtr", + "Cdtr", + "InstrForCdtrAgt" + ], "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" - } - ] + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" }, - "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" - } - ] + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + } }, - "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" - } - ] + "IntrBkSttlmAmt": { + "Amount": 123.45, + "Ccy": "EUR" }, - "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" - } - ] + "Dbtr": { + "Nm": "Debtor Name" }, - "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" - } - ] + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } }, - "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" - } - ] + "DbtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } }, - "Prd": { + "CdtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "Creditor Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "INSTRUCTION" + }, + "Purp": { + "Cd": "CHAR" + }, + "VrfctnOfTerms": { + "Cntt": "CONTENT", + "CnttTp": "PROPRIETARY" + } + } + }, + "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": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "GroupHeader129", + "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", "properties": { - "FrToDt": { + "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": "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" - } + "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": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" + "description": "Payment Instruction Expiry Date and Time\n" } ] }, - "Tp": { + "NbOfTxs": { "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": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\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": "^[0-9]{1,15}$", + "example": 123456789012345 }, { - "description": "Type\n\nIdentification of the period related to the tax payment.\n" + "description": "Number of Transactions\n" } ] }, - "Yr": { + "SttlmInf": { "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 + "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" + } + }, + "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": "Year\n\nYear related to the tax payment.\n" + "description": "Settlement Information\n" } ] } }, + "required": [ + "MsgId", + "CreDtTm", + "NbOfTxs", + "SttlmInf", + "PmtInstrXpryDtTm" + ], "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" + "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "GroupHeader\nSet of characteristics shared by all individual transactions included in the message.\n" } ] }, - "TaxAmt": { + "CdtTrfTxInf": { "allOf": [ { - "title": "TaxAmount3", - "description": "Information on the amount of the tax record.\n", + "title": "CreditTransferTransaction68_FX_Quotes", + "description": "Provides further details specific to the individual transaction(s) included in the message.\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": { + "PmtId": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\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": { + "InstrId": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "title": "ULIDIdentifier", "type": "string", - "example": 123.45, - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\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": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { - "description": "Amount of 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": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, - "Ccy": { + "EndToEndId": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "title": "ULIDIdentifier", "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { - "description": "Currency\nIdentification of the currency in which the account is held.\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\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "TxId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "UETR": { + "allOf": [ + { + "title": "UUIDv4Identifier", + "type": "string", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" + }, + { + "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "TxId" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" } }, { - "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" } ] }, - "TtlAmt": { + "PmtTpInf": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", "type": "object", - "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { - "ActiveOrHistoricCurrencyAndAmount": { + "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": "ActiveOrHistoricCurrencyAndAmount_SimpleType", - "type": "string", - "example": 123.45, - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\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": "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": "Amount of 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": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, - "Ccy": { + "LclInstrm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Dbtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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": "Currency\nIdentification of the currency in which the account is held.\n" + "description": "Party to which an amount of money is due.\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": { + }, + "DbtrAgt": { "allOf": [ { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FrToDt": { + "FinInstnId": { "allOf": [ { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", + "title": "FinancialInstitutionIdentification23", "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "FrDt": { + "BICFI": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. 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": "BICFIDec2014Identifier", "type": "string", - "format": "date", - "example": "2013-03-07" + "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": "FromDate\nStart date of the range.\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" } ] }, - "ToDt": { + "ClrSysMmbId": { "allOf": [ { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. 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": "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", - "format": "date", - "example": "2013-03-07" + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "ToDate\nEnd date of the range.\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 + }, + { + "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": [ - "FrDt", - "ToDt" - ], + "required": [], "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-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": "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": "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": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, + "required": [ + "FinInstnId" + ], "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "Financial institution servicing an account for the debtor.\n" } ] }, - "Amt": { + "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": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", - "type": "string", - "example": 123.45, - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" - }, - { - "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" - } - ] - }, - "Ccy": { + "FinInstnId": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" - } - ] - } - }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } - } - }, - { - "items": { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", - "type": "object", - "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": "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" + } + ] + } }, - { - "description": "ToDate\nEnd date of the range.\n" + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } - ] - } + }, + { + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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" + } + ] + } }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\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" + } + ] }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" - } - ] - } - }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } - } - }, - "type": "array" - } - ] - } - }, - "example": { - "Rate": 0, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 0 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 0 - }, - "Dtls": { - "Tp": "T1", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 - }, - "Inf": 12345 - } - } - }, - { - "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" - } - ] - }, - "Tp": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Type\n\nHigh level code to identify the type of tax details.\n" - } - ] - } - }, - "example": { - "Tp": "VAT", - "Ctgy": "A", - "CtgyDtls": "Standard", - "DbtrSts": "Resident", - "CertId": 123456789, - "FrmsCd": 123456789, - "Prd": { - "Yr": 2019, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2019-01-01", - "ToDt": "2019-12-31" - } - }, - "TaxAmt": { - "Rate": 0.2, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 1000 - }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 200 - } - }, - "AddtlInf": "VAT applicable" - } - }, - "TaxRecordDetails3": { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", - "type": "object", - "properties": { - "Prd": { - "allOf": [ - { - "title": "TaxPeriod3", - "description": "Period of time details related to the tax payment.\n", - "type": "object", - "properties": { - "FrToDt": { - "allOf": [ - { - "title": "DatePeriod2", - "description": "Range of time defined by a start date and an end date.\n", - "type": "object", - "properties": { - "FrDt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "FromDate\nStart date of the range.\n" - } - ] - }, - "ToDt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "ToDate\nEnd date of the range.\n" - } - ] - } - }, - "required": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-31" - } - }, - { - "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" - } - ] - }, - "Tp": { - "allOf": [ - { - "title": "TaxRecordPeriod1Code", - "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", - "type": "string", - "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" - }, - { - "description": "Type\n\nIdentification of the period related to the tax payment.\n" - } - ] - }, - "Yr": { - "allOf": [ - { - "title": "ISOYear", - "description": "Year represented by YYYY (ISO 8601).\n", - "type": "string", - "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", - "example": 2019 - }, - { - "description": "Year\n\nYear related to the tax payment.\n" - } - ] - } - }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - } - }, - { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" - } - ] - }, - "Amt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveOrHistoricCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", - "type": "string", - "example": 123.45, - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" - }, - { - "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" - } - ] - } - }, - "required": [ - "Amt" - ], - "example": { - "Prd": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } - } - }, - "TaxRecordPeriod1Code": { - "title": "TaxRecordPeriod1Code", - "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", - "type": "string", - "enum": [ - "MM01", - "MM02", - "MM03", - "MM04", - "MM05", - "MM06", - "MM07", - "MM08", - "MM09", - "MM10", - "MM11", - "MM12", - "QTR1", - "QTR2", - "QTR3", - "QTR4", - "HLF1", - "HLF2" - ], - "example": "HLF1" - }, - "TermsRequest_FIToFICustomerCreditProposal": { - "title": "TermsRequest_FIToFICustomerCreditProposal", - "type": "object", - "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" + "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" + } + ] + } + }, + "required": [ + "Dbtr", + "Cdtr", + "DbtrAgt", + "CdtrAgt", + "InstdAmt" + ] }, { - "description": "Payment Instruction Expiry Date and Time\n" + "description": "Underlying Customer Credit Transfer\nTBD\n" } ] }, - "NbOfTxs": { + "IntrBkSttlmAmt": { "allOf": [ { - "title": "Max15NumericText", - "description": "Specifies a numeric string with a maximum length of 15 digits.\n", - "type": "string", - "pattern": "^[0-9]{1,15}$", - "example": 123456789012345 + "title": "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", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } }, { - "description": "Number of Transactions\n" + "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" } ] }, - "SttlmInf": { + "Dbtr": { "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": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "SttlmMtd": { - "title": "SettlementMethod1Code", - "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n", - "type": "string", - "enum": [ - "INDA", - "INGA", - "COVE", - "CLRG" - ], - "example": "CLRG" - }, - "PmtTpInf": { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", - "type": "object", - "properties": { - "InstrPrty": { - "title": "Priority2Code", - "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", - "type": "string", - "enum": [ - "HIGH", - "NORM" - ], - "example": "HIGH" - }, - "ClrChanl": { - "title": "ClearingChannel2Code", - "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", - "type": "string", - "enum": [ - "RTGS", - "RTNS", - "MPNS", - "BOOK" - ], - "example": "RTGS" - }, - "SvcLvl": { - "allOf": [ - { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", - "type": "object", - "anyOf": [ + "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", @@ -142382,57 +173562,401 @@ "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", + "description": "Specifies a character string with a 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", @@ -142443,453 +173967,633 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nSpecifies the local instrument, 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": "CH03" - } + ] + } + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - { - "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" + "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 } - ] + } }, - "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": [ + { + "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": { - "Cd": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", - "maxLength": 4, - "minLength": 1, - "type": "string", - "example": 1234 + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\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\nCategory purpose, as published in an external category purpose 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" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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": "Max35Text", - "description": "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": "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": { - "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" - } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" } } }, - "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": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "EndToEndId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "TxId": { - "allOf": [ - { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - { - "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" - } - ] - }, - "UETR": { - "allOf": [ - { - "title": "UUIDv4Identifier", - "type": "string", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" - }, - { - "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" - } - ] - }, - "ClrSysRef": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "TxId" + "FinInstnId" ], "example": { - "InstrId": "INSTRUCTIONID", - "EndToEndId": "ENDTOENDID", - "TxId": "TRANSACTIONID", - "UETR": "123e4567-e89b-12d3-a456-426614174000", - "ClrSysRef": "CLRSYSREF" + "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": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" + "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" } ] }, - "PmtTpInf": { + "DbtrAcct": { "allOf": [ { - "title": "PaymentTypeInformation28", - "description": "Provides further details of the type of payment.\n", + "title": "CashAccount40", "type": "object", + "description": "Provides the details to identify an account.\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": { + "Id": { "allOf": [ { - "title": "ServiceLevel8Choice", - "description": "Details about a service level.\n", + "title": "AccountIdentification4Choice", "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { - "Cd": { + "IBAN": { "allOf": [ { - "title": "ExternalServiceLevel1Code", - "description": "Specifies the external service level code.", + "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", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "example": "FR1420041010050500013M02606", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { - "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": "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": [ - "Cd" + "IBAN" ] }, { "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 + "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": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" + "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ - "Prtry" + "Othr" ] } ], "example": { - "Cd": "SEPA" + "IBAN": "BE71096123456769" } }, { - "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" + "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, - "LclInstrm": { + "Tp": { "allOf": [ { - "title": "LocalInstrument2Choice", + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\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": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\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": 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" + "description": "Code\nAccount type, in a coded form.\n" } ] } @@ -142911,7 +174615,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nCategory purpose, in a proprietary form.\n" + "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } @@ -142922,263 +174626,470 @@ } ], "example": { - "Cd": "CASH" + "Cd": "CACC" } }, { - "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" + "description": "Type\nSpecifies the nature, or use of the account.\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": { + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "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": "Currency\nIdentification of the currency in which the account is held.\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": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "Id" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 } }, { - "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": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" }, - "Dbtr": { + "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": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "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": [ { @@ -143190,14 +175101,14 @@ "example": 12345 }, { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { - "title": "PostalAddress27", + "title": "PostalAddress24", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -143312,14 +175223,6 @@ "Cd": "ADDR" } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", @@ -143337,12 +175240,12 @@ "example": 1.2345678901234567e+99 }, "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", @@ -143353,12 +175256,12 @@ "example": 1234567890123456 }, "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", @@ -143368,14 +175271,6 @@ "maxLength": 70, "example": 1.2345678901234567e+99 }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", @@ -143401,28 +175296,28 @@ "example": 1234567890123456 }, "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", @@ -143450,14 +175345,12 @@ }, "example": { "AdrTp": "ADDR", - "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", - "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", @@ -143470,595 +175363,18 @@ } }, { - "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" + "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": { - "allOf": [ - { - "title": "Max35Text", - "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": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -144069,163 +175385,176 @@ "example": 1.234567890123457e+34 }, { - "description": "Responsibility\nRole of a person in an organisation.\n" - } - ] - }, - "Dept": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Othr": { + "SchmeNm": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "properties": { - "ChanlTp": { - "allOf": [ - { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] } + }, + "required": [ + "Cd" ] }, - "Id": { - "allOf": [ - { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 128, - "example": 12345 - }, - { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "ChanlTp" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Cd": "BIC" } }, { - "description": "OtherContact\nContact details in another form.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "PrefrdMtd": { + "Issr": { "allOf": [ { - "title": "PreferredContactMethod2Code", - "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "MAIL" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "URLAdr": "http://www.example.com", - "EmailAdr": "example@example.com" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Id" - ], + "required": [], "example": { - "Nm": "John Doe", + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 + }, + "LEI": 123, + "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry" + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } - }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "Issr": 123 } } }, { - "description": "Party that owes an amount of money to the (ultimate) creditor.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "Cdtr": { + "BrnchId": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" + } + ] + }, "Nm": { "allOf": [ { @@ -144237,7 +175566,7 @@ "example": 12345 }, { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, @@ -144517,595 +175846,486 @@ } }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" + } + ] + }, + "CdtrAgt": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "description": "Information used to identify a financial institution.\n", + "properties": { + "BICFI": { + "allOf": [ + { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, - "Id": { + "ClrSysMmbId": { "allOf": [ { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", - "anyOf": [ - { - "properties": { - "OrgId": { - "allOf": [ + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify an organisation.\n", - "type": "object", "properties": { - "AnyBIC": { - "allOf": [ - { - "title": "AnyBICDec2014Identifier", - "type": "string", - "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - { - "description": "AnyBIC\nBusiness identification code of the organisation.\n" - } - ] - }, - "LEI": { + "Cd": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" - }, - { - "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" - } - ] - }, - "Othr": { - "allOf": [ - { - "title": "GenericOrganisationIdentification3", - "type": "object", - "description": "Information related to an identification of an organisation.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 - }, - { - "description": "Identification\nIdentification assigned by an institution.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", - "type": "object", - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" - } - ] - }, - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" - } - ] - } - }, - "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": 5, + "example": 12345 }, { - "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, - "example": { - "AnyBIC": "BICFI", - "LEI": "529900T8BM49AURSDO55", - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } - } + "required": [ + "Cd" + ] }, { - "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" - } - ] - } - }, - "required": [ - "OrgId" - ] - }, - { - "properties": { - "PrvtId": { - "allOf": [ - { - "title": "PersonIdentification18", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", "properties": { - "DtAndPlcOfBirth": { - "allOf": [ - { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", - "properties": { - "BirthDt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "BirthDate\nDate on which a person was born.\n" - } - ] - }, - "PrvcOfBirth": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "ProvinceOfBirth\nProvince where a person was born.\n" - } - ] - }, - "CityOfBirth": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "CityOfBirth\nCity where a person was born.\n" - } - ] - }, - "CtryOfBirth": { - "allOf": [ - { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - { - "description": "CountryOfBirth\nCountry where a person was born.\n" - } - ] - } - }, - "required": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" - ], - "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" - } - }, - { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" - } - ] - }, - "Othr": { + "Prtry": { "allOf": [ { - "title": "GenericPersonIdentification2", - "type": "object", - "description": "Identification of a person.", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 - }, - { - "description": "Identification\nUnique and unambiguous identification of a person.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "type": "object", - "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": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 - } - } - } - }, - { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "CHIPS" + } + }, + { + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + } + ] + }, + "MmbId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } - }, - "required": [ - "PrvtId" ] } + }, + "required": [ + "MmbId" ], "example": { - "OrgId": { - "AnyBIC": "BIC" + "ClrSysId": { + "Cd": "CHQB" }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } + "MmbId": 123456789 } }, { - "description": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "CtryOfRes": { + "LEI": { "allOf": [ { - "title": "CountryCode", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, - "CtctDtls": { + "Nm": { "allOf": [ { - "title": "Contact13", - "description": "Specifies the details of the contact person.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "NmPrfx": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", - "enum": [ - "DOCT", - "MADM", - "MISS", - "MIST", - "MIKS" - ], - "type": "string", - "example": "DOCT" + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, { - "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" - } - ] + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - "PhneNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" - }, - { - "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" - } - ] + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - "MobNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" - }, - { - "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" - } - ] + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - "FaxNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" - }, - { - "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" - } - ] + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 }, - "URLAdr": { - "allOf": [ - { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 - }, - { - "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" - } - ] + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, - "EmailAdr": { - "allOf": [ - { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 - }, - { - "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" - } - ] + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - "EmailPurp": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" - } - ] + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 }, - "JobTitl": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "JobTitle\nTitle of the function.\n" - } - ] + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "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": { + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "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", @@ -145116,732 +176336,945 @@ "example": 1.234567890123457e+34 }, { - "description": "Responsibility\nRole of a person in an organisation.\n" - } - ] - }, - "Dept": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Othr": { + "SchmeNm": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "properties": { - "ChanlTp": { - "allOf": [ - { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] } + }, + "required": [ + "Cd" ] }, - "Id": { - "allOf": [ - { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 128, - "example": 12345 - }, - { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "ChanlTp" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Cd": "BIC" } }, { - "description": "OtherContact\nContact details in another form.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "PrefrdMtd": { + "Issr": { "allOf": [ { - "title": "PreferredContactMethod2Code", - "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "MAIL" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, + "required": [ + "Id" + ], "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "URLAdr": "http://www.example.com", - "EmailAdr": "example@example.com" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Id" - ], + "required": [], "example": { - "Nm": "John Doe", + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 + }, + "LEI": 123, + "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry" + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } - } - }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "Issr": 123 } } }, { - "description": "Party 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" } ] }, - "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" - }, - { - "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" + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" + } + ] + }, + "Cdtr": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "description": "Information used to identify a financial institution.\n", + "properties": { + "BICFI": { + "allOf": [ + { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + } + ] + }, + "ClrSysMmbId": { + "allOf": [ + { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + { + "description": "Code\nClearing system identification code, as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "Othr": { + "MmbId": { "allOf": [ { - "title": "GenericFinancialIdentification1", - "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + } + ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + { + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identifier of the financial institution.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { "properties": { - "Id": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "example": "ADDR" }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "SchmeNm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "GenericIdentification30", "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "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": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" - } - ] + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" } - }, - "required": [ - "Prtry" ] } + }, + "required": [ + "Id", + "Issr" ], "example": { - "Cd": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "Prtry" + ] } - ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 + ], + "example": { + "Cd": "ADDR" + } }, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "BrnchId": { + "Othr": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "GenericFinancialIdentification1", "type": "object", + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ @@ -145854,556 +177287,601 @@ "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" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Prtry" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - ], - "example": { - "Cd": "ADDR" - } - }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + ] } }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } }, "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, - "required": [ - "FinInstnId" - ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" } } }, { - "description": "Financial institution servicing an account for the debtor.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "CdtrAgt": { + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Creditor\nParty to which an amount of money is due.\n" + } + ] + }, + "CdtrAcct": { + "allOf": [ + { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "AccountIdentification4Choice", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", - "properties": { - "FinInstnId": { - "allOf": [ - { - "title": "FinancialInstitutionIdentification23", - "type": "object", - "description": "Information used to identify a financial institution.\n", - "properties": { - "BICFI": { - "allOf": [ - { - "title": "BICFIDec2014Identifier", - "type": "string", - "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - { - "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" - } - ] + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "anyOf": [ + { + "properties": { + "IBAN": { + "allOf": [ + { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "example": "FR1420041010050500013M02606", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, - "ClrSysMmbId": { - "allOf": [ - { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", - "properties": { - "ClrSysId": { - "allOf": [ - { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "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": "IBAN\nInternational Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions.\n" + } + ] + } + }, + "required": [ + "IBAN" + ] + }, + { + "properties": { + "Othr": { + "allOf": [ + { + "title": "GenericAccountIdentification1", + "type": "object", + "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 }, - "MmbId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" - } - ] + { + "description": "Identification\nIdentification assigned by an institution.\n" } - }, - "required": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 - } - }, - { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" - }, - { - "description": "LEI\nLegal entity identifier of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + ] }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", + "SchmeNm": { + "allOf": [ + { + "title": "AccountSchemeName1Choice", "type": "object", - "description": "Choice of formats for the type of address.\n", + "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" } ] } @@ -146417,67 +177895,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" } ] } @@ -146488,106 +177914,17 @@ } ], "example": { - "Cd": "ADDR" + "Cd": 1111 } }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -146595,480 +177932,341 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "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" + ] } - ] - }, - "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" - } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - { - "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 + "Issr": "BIC" + } }, - "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": "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 }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + { + "description": "Code\nAccount type, in a coded form.\n" } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + ] } + }, + "required": [ + "Cd" ] }, - "BrnchId": { + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nNature or use of the account in a proprietary form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + { + "description": "Type\nSpecifies the nature, or use of the account.\n" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\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", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "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", @@ -147076,324 +178274,763 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "Proprietary\nProxy account type, in a proprietary form.\n" } - }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + ] } + }, + "required": [ + "Prtry" ] } - }, + ], "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "Cd": "EMAIL" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Type\nType of the proxy identification.\n" + } + ] + }, + "Id": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + { + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ - "FinInstnId" + "Id" ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "Tp": { + "Cd": "IBAN" }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } + "Id": 123 } }, { - "description": "Financial institution servicing an account for the creditor.\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, - "required": [ - "Dbtr", - "Cdtr", - "DbtrAgt", - "CdtrAgt" - ] + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } }, { - "description": "Underlying Customer Credit Transfer\nTBD\n" + "description": "CreditorAccount\nAccount to which a credit entry is made.\n" + } + ] + }, + "InstrForCdtrAgt": { + "allOf": [ + { + "title": "InstructionForCreditorAgent3_Put_FX_Quotes_ID", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalCreditorAgentInstruction1Code", + "description": "Specifies the instruction given by the creditor to the creditor agent.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" + } + ] + }, + "InstrInf": { + "allOf": [ + { + "title": "AmountTypeEnum", + "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", + "type": "string", + "enum": [ + "SEND", + "RECEIVE" + ], + "example": "SEND" + }, + { + "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" + } + ] + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + { + "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" + } + ] + }, + "Purp": { + "allOf": [ + { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", + "type": "object", + "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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + { + "description": "SHA-256 signature of the terms\n" + } + ] + } + }, + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + }, + { + "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" + } + ] + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "UndrlygCstmrCdtTrf", + "Dbtr", + "Cdtr", + "InstrForCdtrAgt" + ], + "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" + } + } + } + } + } + }, + "CreditTransferTransaction68_FX_Quotesb": { + "title": "CreditTransferTransaction68_FX_Quotes", + "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": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "EndToEndId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "TxId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "UETR": { + "allOf": [ + { + "title": "UUIDv4Identifier", + "type": "string", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" + }, + { + "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" + } + ] + } + }, + "required": [ + "TxId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + { + "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" + } + ] + }, + "PmtTpInf": { + "allOf": [ + { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "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" } ] }, - "IntrBkSttlmAmt": { + "CtgyPurp": { "allOf": [ { - "title": "ActiveCurrencyAndAmount", + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", - "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount_SimpleType", - "type": "string", - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\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 + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + { + "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" + } + ] } + }, + "required": [ + "Cd" ] }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" + } ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "ActiveCurrencyAndAmount", - "Ccy" ], "example": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Cd": "CASH" } }, { - "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" + "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + { + "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" + } + ] + }, + "UndrlygCstmrCdtTrf": { + "allOf": [ + { + "title": "UnderlyingCustomerCreditTransfer", + "type": "object", + "properties": { "InstdAmt": { "allOf": [ { @@ -147510,780 +179147,191 @@ "LRD", "LSL", "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" - } - ] - }, - "XchgRate": { - "allOf": [ - { - "title": "BaseOneRate", - "type": "string", - "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", - "example": 0.7, - "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" - }, - { - "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n" - } - ] - }, - "ChrgBr": { - "title": "ChargeBearerType1Code", - "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", - "type": "string", - "enum": [ - "DEBT", - "CRED", - "SHAR" - ], - "example": "DEBT" - }, - "ChrgsInf": { - "allOf": [ - { - "title": "Charges16", - "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n", - "type": "object", - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" - } - ] - }, - "Agt": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "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" - } + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Dbtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "Othr": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "GenericIdentification30", "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "description": "Generic scheme identification for a party.\n", "properties": { "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -148294,24 +179342,291 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", - "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "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": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "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": "ExternalFinancialInstitutionIdentification1Code", - "description": "Specifies the external financial institution identification code.", + "title": "ExternalOrganisationIdentification1Code", + "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, @@ -148321,14 +179636,7 @@ "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { + }, "Prtry": { "allOf": [ { @@ -148345,218 +179653,228 @@ ] } }, - "required": [ - "Prtry" - ] + "anyOf": [ + { + "properties": { + "Cd": {} + } + }, + { + "properties": { + "Prtry": {} + } + } + ], + "example": { + "Cd": "BIC" + } + }, + { + "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": "BIC" }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] + "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" }, - "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" + "Issr": "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": 123, - "Prtry": 123 - }, - "Issr": 123 + { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } - } - }, - { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + ] } + }, + "required": [ + "OrgId" ] }, - "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 + { + "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": "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", + "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", @@ -148567,374 +179885,416 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } - }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "CCPT" + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum 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" ] } - ], - "example": { - "Cd": "ADDR" - } - }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } }, - "AdrLine": { - "title": "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": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\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": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] - } - }, - "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" + } + }, + { + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } - } - }, - { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + ] } + }, + "required": [ + "PrvtId" ] } - }, - "required": [ - "FinInstnId" ], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "OrgId": { + "AnyBIC": "BIC" }, - "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" + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" } } } }, { - "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" + "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, - "Tp": { + "CtryOfRes": { "allOf": [ { - "title": "ChargeType3Choice", - "description": "ChargeType3Choice\nSpecifies the type of charge.\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", - "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": { + "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" } - }, - "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" - } - ] + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 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 }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } - }, - "required": [ - "Id" - ], - "example": { - "Id": 123, - "Issr": "BIC" - } + ] }, - { - "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\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" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "CASH" + "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": "Type\nDefines the type of charges.\n" + "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ - "Amt", - "Agt" + "Id" ], "example": { - "Amt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" }, - "Agt": { - "BrnchId": { - "Id": "BRANCHID" + "Id": { + "OrgId": { + "AnyBIC": "BIC" }, - "FinInstnId": { - "BICFI": "BICFI" + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } } }, - "Tp": { - "Cd": "SHAR" + "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": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n" + "description": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, - "Dbtr": { + "Cdtr": { "allOf": [ { "title": "PartyIdentification272", @@ -149977,550 +181337,7 @@ } }, { - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - { - "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" - } - ] - }, - "Prxy": { - "allOf": [ - { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", - "type": "object", - "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" + "description": "Party to which an amount of money is due.\n" } ] }, @@ -151471,7 +182288,7 @@ } }, { - "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" + "description": "Financial institution servicing an account for the debtor.\n" } ] }, @@ -151482,460 +182299,55 @@ "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" - } + "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\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" } ] }, - "Othr": { + "ClrSysMmbId": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\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": { + "ClrSysId": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\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": "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" } ] } @@ -151957,7 +182369,7 @@ "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" } ] } @@ -151968,15 +182380,15 @@ } ], "example": { - "Cd": "BIC" + "Cd": "CHIPS" } }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "Issr": { + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -151987,83 +182399,23 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "Id" + "MmbId" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + "ClrSysId": { + "Cd": "CHQB" }, - "Issr": "BIC" + "MmbId": 123456789 } }, { - "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" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, @@ -152077,7 +182429,7 @@ "example": "529900T8BM49AURSDO55" }, { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, @@ -152092,14 +182444,14 @@ "example": 12345 }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { - "title": "PostalAddress27", + "title": "PostalAddress24", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -152214,14 +182566,6 @@ "Cd": "ADDR" } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", @@ -152239,12 +182583,12 @@ "example": 1.2345678901234567e+99 }, "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", @@ -152255,12 +182599,12 @@ "example": 1234567890123456 }, "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", @@ -152270,14 +182614,6 @@ "maxLength": 70, "example": 1.2345678901234567e+99 }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", @@ -152303,28 +182639,28 @@ "example": 1234567890123456 }, "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 140, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", @@ -152352,14 +182688,12 @@ }, "example": { "AdrTp": "ADDR", - "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", - "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", @@ -152375,585 +182709,61 @@ "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": [ + }, + "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": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "example": "ADDR" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "SchmeNm": { "allOf": [ { - "title": "GenericIdentification30", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "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": [ + "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": { - "allOf": [ - { - "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": { + "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 + "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" } ] } }, "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } + "Cd" + ] }, { - "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": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -152964,340 +182774,102 @@ "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" + "description": "Proprietary\nName of the identification scheme, in a free text form.\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" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "BIC" + } }, - "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": "SchemeName\nName of the identification scheme.\n" } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + ] + }, + "Issr": { + "allOf": [ + { + "title": "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": "Issuer\nEntity that assigns the identification.\n" } - } - }, - { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + ] } - ] + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } - }, - "required": [ - "PrvtId" ] } - ], + }, + "required": [], "example": { - "OrgId": { - "AnyBIC": "BIC" + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "Identification\nUnique and unambiguous identification of a party.\n" - } - ] - }, - "CtryOfRes": { - "allOf": [ - { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - { - "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "CtctDtls": { + "BrnchId": { "allOf": [ { - "title": "Contact13", - "description": "Specifies the details of the contact person.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "properties": { - "NmPrfx": { - "allOf": [ - { - "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", - "enum": [ - "DOCT", - "MADM", - "MISS", - "MIST", - "MIKS" - ], - "type": "string", - "example": "DOCT" - }, - { - "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" - } - ] - }, - "PhneNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" - }, - { - "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" - } - ] - }, - "MobNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" - }, - { - "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" - } - ] - }, - "FaxNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" - }, - { - "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" - } - ] - }, - "URLAdr": { - "allOf": [ - { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 - }, - { - "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" - } - ] - }, - "EmailAdr": { - "allOf": [ - { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 - }, - { - "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" - } - ] - }, - "EmailPurp": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" - } - ] - }, - "JobTitl": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -153308,292 +182880,663 @@ "example": 1.234567890123457e+34 }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "Rspnsblty": { + "LEI": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, - "Dept": { + "Nm": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "maxLength": 140, + "example": 12345 }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, - "Othr": { + "PstlAdr": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "PostalAddress27", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "ChanlTp": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "Id": { - "allOf": [ - { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 128, - "example": 12345 - }, - { - "description": "Identifier\nCommunication value such as phone number or email address.\n" - } - ] + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } }, - "required": [ - "ChanlTp" - ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "OtherContact\nContact details in another form.\n" - } - ] - }, - "PrefrdMtd": { - "allOf": [ - { - "title": "PreferredContactMethod2Code", - "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", - "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "MAIL" - }, - { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "URLAdr": "http://www.example.com", - "EmailAdr": "example@example.com" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "Id" + "FinInstnId" ], "example": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" } - }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" } } }, { - "description": "Creditor\nParty to which an amount of money is due.\n" + "description": "Financial institution servicing an account for the creditor.\n" + } + ] + } + }, + "required": [ + "Dbtr", + "Cdtr", + "DbtrAgt", + "CdtrAgt", + "InstdAmt" + ] + }, + { + "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 } ] }, - "CdtrAcct": { + "Ccy": { "allOf": [ { - "title": "CashAccount40", + "title": "ActiveCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" + } + ] + }, + "Dbtr": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "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", @@ -153604,327 +183547,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" - } - ] - } - }, - "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" + "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\nNature or use of the account in a proprietary form.\n" - } - ] + "MmbId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } - }, - "required": [ - "Prtry" ] } + }, + "required": [ + "MmbId" ], "example": { - "Cd": "CACC" + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "description": "Type\nSpecifies the nature, or use of the account.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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 identifier 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": "PostalAddress24", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Tp": { + "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": "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" } ] } @@ -153946,7 +183952,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" } ] } @@ -153957,26 +183963,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" } ] } @@ -153985,60 +183991,92 @@ "Id" ], "example": { - "Tp": { + "Id": 123, + "SchmeNm": { "Cd": "IBAN" }, - "Id": 123 + "Issr": "BIC" } }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, + "required": [], "example": { - "Id": { - "IBAN": "BE71096123456769" + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "Tp": { - "Cd": "CACC" + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "CreditorAccount\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": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "InstrForCdtrAgt": { + "BrnchId": { "allOf": [ { - "title": "InstructionForCreditorAgent3", - "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalCreditorAgentInstruction1Code", - "description": "Specifies the instruction given by the creditor to the creditor agent.", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "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": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "InstrInf": { + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[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", @@ -154049,76 +184087,512 @@ "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": "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": { - "Cd": "PHOA", - "InstrInf": "Please advise/contact next agent by phone." + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "InstrForNxtAgt": { + "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": "InstructionForNextAgent1", - "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n", + "title": "AccountIdentification4Choice", "type": "object", - "properties": { - "Cd": { - "allOf": [ - { - "title": "Instruction4Code", - "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", - "type": "string", - "enum": [ - "PHOA", - "TELA" - ], - "example": "PHOA" - }, - { - "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n" + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "anyOf": [ + { + "properties": { + "IBAN": { + "allOf": [ + { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "example": "FR1420041010050500013M02606", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" + }, + { + "description": "IBAN\nInternational Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions.\n" + } + ] } + }, + "required": [ + "IBAN" ] }, - "InstrInf": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n" + { + "properties": { + "Othr": { + "allOf": [ + { + "title": "GenericAccountIdentification1", + "type": "object", + "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + { + "description": "Identification\nIdentification assigned by an institution.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" + } + ] } + }, + "required": [ + "Othr" ] } - }, + ], "example": { - "Cd": "PHOA", - "InstrInf": "Please advise/contact next agent by phone." + "IBAN": "BE71096123456769" } }, { - "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n" + "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, - "Purp": { + "Tp": { "allOf": [ { - "title": "Purpose2Choice", - "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", "type": "object", "anyOf": [ { @@ -154126,15 +184600,15 @@ "Cd": { "allOf": [ { - "title": "ExternalPurpose1Code", - "description": "Specifies the external purpose code.", + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { - "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" + "description": "Code\nAccount type, in a coded form.\n" } ] } @@ -154156,7 +184630,7 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\n\nPurpose, in a proprietary form.\n" + "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } @@ -154167,698 +184641,251 @@ } ], "example": { - "Cd": "CH03" + "Cd": "CACC" } }, { - "description": "Purpose\nUnderlying reason for the payment transaction.\n" + "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, - "RgltryRptg": { + "Ccy": { "allOf": [ { - "title": "RegulatoryReporting3", - "description": "Information needed due to regulatory and/or statutory requirements.\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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", "type": "object", "properties": { - "DbtCdtRptgInd": { - "allOf": [ - { - "title": "RegulatoryReportingType1Code", - "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n", - "type": "string", - "enum": [ - "CRED", - "DEBT", - "BOTH" - ], - "example": "BOTH" - }, - { - "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n" - } - ] - }, - "Authrty": { + "Tp": { "allOf": [ { - "title": "RegulatoryAuthority2", - "description": "Information about an entity requiring the regulatory reporting information.\n", - "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", + "title": "ProxyAccountType1Choice", + "description": "Specifies the type of the proxy account.\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" - } - ] + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalProxyAccountType1Code", + "description": "Specifies the external proxy account type code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] + { + "description": "Code\nProxy account type, in a coded form as published in an external list.\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" + ] } + }, + "required": [ + "Cd" ] - } - }, - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" - } - ] - }, - "Inf": { - "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", - "anyOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "items": { + { + "properties": { + "Prtry": { + "allOf": [ + { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -154866,270 +184893,174 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "type": "array" - } - ] - } - }, - "example": { - "Tp": "T1", - "Dt": "2018-01-01", - "Ctry": "CH", - "Cd": "CHF", - "Amt": { - "Ccy": "CHF", - "Amt": 1000 + { + "description": "Proprietary\nProxy account type, in a proprietary form.\n" + } + ] + } }, - "Inf": 12345 + "required": [ + "Prtry" + ] } - }, - "type": "array" + ], + "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": { - "DbtCdtRptgInd": "CRED", - "Authrty": { - "Nm": "Swiss National Bank", - "Ctry": "CH" + "Tp": { + "Cd": "IBAN" }, - "Dtls": { - "Cd": "A1", - "Inf": "Mandatory regulatory information" - } + "Id": 123 } }, { - "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" }, - "Tax": { + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + { + "description": "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": "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": "FinancialInstitutionIdentification23", "type": "object", + "description": "Information used to identify a financial institution.\n", "properties": { - "Cdtr": { + "BICFI": { "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": "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": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\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" } ] }, - "Dbtr": { + "ClrSysMmbId": { "allOf": [ { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\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": { - "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": { + "ClrSysId": { "allOf": [ { - "title": "TaxAuthorisation1", - "description": "Details of an authorised tax paying party.\n", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\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" + "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" ] }, - "Nm": { - "allOf": [ - { - "title": "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": { - "Titl": "Mr", - "Nm": "John Doe" + "Cd": "CHIPS" } }, { - "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" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "TaxTp": { + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -155140,90 +185071,41 @@ "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" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, + "required": [ + "MmbId" + ], "example": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT", - "Authstn": { - "Titl": "Mr", - "Nm": "John Doe" - } + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "AdmstnZone": { + "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": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, - "RefNb": { + "Nm": { "allOf": [ { "title": "Max140Text", @@ -155234,523 +185116,280 @@ "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" + "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": "PostalAddress24", "type": "object", - "description": "A number 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": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\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": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\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": "Currency\nIdentification of the currency in which the account is held.\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": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" - } - ] - }, - "Dt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "Date\n\nDate by which tax is due.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "SeqNb": { + "Othr": { "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", + "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": { - "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": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -155761,26 +185400,72 @@ "example": 1.234567890123457e+34 }, { - "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "CtgyDtls": { + "SchmeNm": { "allOf": [ { - "title": "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": "CategoryDetails\n\nProvides further details of the category tax code.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "DbtrSts": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -155791,1351 +185476,947 @@ "example": 1.234567890123457e+34 }, { - "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" }, - "FrmsCd": { - "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": "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" + "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" + } + }, + "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" ] }, - "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" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + "Cd": "CHIPS" } }, { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "TaxAmt": { + "MmbId": { "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "title": "Max35Text", + "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" ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "type": "string", + "example": "ADDR" }, { - "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "TtlAmt": { + } + }, + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" - } - ] - }, - "Dtls": { - "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", - "anyOf": [ - { - "title": "TaxRecordDetails3", - "description": "Details on the tax period and amount.\n", - "type": "object", - "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" - } - } + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] }, - "Amt": { + "SchmeNm": { "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + "title": "Max35Text", + "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": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" - } - ] - } + "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", @@ -157146,1762 +186427,2175 @@ "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": "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": "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": [ + "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": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-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 + }, + { + "description": "SchemeName\nShort textual description of the 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": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } - ] - } - }, - "example": { - "Yr": 2020, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2020-01-01", - "ToDt": "2020-01-31" - } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary 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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" + } + ] + }, + "Cdtr": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "allOf": [ + { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "description": "Information used to identify a financial institution.\n", + "properties": { + "BICFI": { + "allOf": [ + { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + } + ] + }, + "ClrSysMmbId": { + "allOf": [ + { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + { + "description": "Code\nClearing system identification code, 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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "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" + } + ] + } + }, + "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" + } + ] } }, - { - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" - } - ] - } + }, + { + "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" } - }, - { - "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\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 }, - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" - } - ] + { + "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 }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" + { + "description": "Issuer\nEntity that assigns the identification.\n" } - } + ] }, - "type": "array" + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } - ] - } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + } + ] + } + }, + "example": { + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } + } + }, + { + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + } + ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Creditor\nParty to which an amount of money is due.\n" + } + ] + }, + "CdtrAcct": { + "allOf": [ + { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "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 }, - "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": "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" + ] }, - "Inf": 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\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" } - }, - { - "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" - } - ] - }, - "Tp": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Type\n\nHigh level code to identify the type of tax details.\n" - } - ] - } - }, - "example": { - "Tp": "VAT", - "Ctgy": "A", - "CtgyDtls": "Standard", - "DbtrSts": "Resident", - "CertId": 123456789, - "FrmsCd": 123456789, - "Prd": { - "Yr": 2019, - "Tp": "MM01", - "FrToDt": { - "FrDt": "2019-01-01", - "ToDt": "2019-12-31" - } - }, - "TaxAmt": { - "Rate": 0.2, - "TaxblBaseAmt": { - "Ccy": "EUR", - "Amt": 1000 + ] }, - "TtlAmt": { - "Ccy": "EUR", - "Amt": 200 + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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": "VAT applicable" + "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" } - }, - "type": "array" + ] } + }, + "required": [ + "Othr" ] } - }, + ], "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 + "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" + ] }, - "Dt": "2018-01-01", - "SeqNb": 1, - "Rcrd": { - "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\nNature or use of the account in a proprietary form.\n" + } + ] + } }, - "Inf": 12345 + "required": [ + "Prtry" + ] } + ], + "example": { + "Cd": "CACC" } }, { - "description": "Tax\nProvides details on the tax.\n" + "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, - "VrfctnOfTerms": { - "title": "CryptographicLockChoice", - "description": "Cryptographically signed terms\n", - "type": "object", - "anyOf": [ + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", "properties": { - "IlpV4PrepPacket": { + "Tp": { "allOf": [ { - "title": "hexBinary", - "type": "string", - "example": 4660, - "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" + "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": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" + "description": "Type\nType of the proxy identification.\n" } ] - } - }, - "required": [ - "IlpV4PrepPacket" - ] - }, - { - "properties": { - "Sh256Sgntr": { + }, + "Id": { "allOf": [ { - "title": "Exact32HexBinaryText", - "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", - "pattern": "^[A-Za-z0-9-_]{43}$", - "maxLength": 48 + "minLength": 1, + "maxLength": 2048, + "example": 2048 }, { - "description": "SHA-256 signature of the terms\n" + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ - "Sh256Sgntr" - ] + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + }, + { + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } - ], - "example": { - "IlpV4PrepPacket": "1234567890ABCDEF" - } + ] } }, - "required": [ - "PmtId", - "IntrBkSttlmAmt", - "ChrgBr", - "Dbtr", - "DbtrAgt", - "CdtrAgt", - "Cdtr" - ], "example": { - "PmtId": { - "InstrId": "INSTRID", - "EndToEndId": "ENDTOENDID" - }, - "PmtTpInf": { - "LclInstrm": { - "Cd": "CHQB", - "Prtry": "PROPRIETARY" - }, - "SeqTp": "SEQTP" + "Id": { + "IBAN": "BE71096123456769" }, - "IntrBkSttlmAmt": { - "ActiveCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Tp": { + "Cd": "CACC" }, - "InstdAmt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + { + "description": "CreditorAccount\nAccount to which a credit entry is made.\n" + } + ] + }, + "InstrForCdtrAgt": { + "allOf": [ + { + "title": "InstructionForCreditorAgent3_Put_FX_Quotes_ID", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "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" + } + ] }, - "XchgRate": 123.45, - "ChrgBr": "SHAR", - "ChrgsInf": { - "Amt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - }, - "Agt": { - "BrnchId": { - "Id": "BRANCHID" + "InstrInf": { + "allOf": [ + { + "title": "AmountTypeEnum", + "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", + "type": "string", + "enum": [ + "SEND", + "RECEIVE" + ], + "example": "SEND" }, - "FinInstnId": { - "BICFI": "BICFI" + { + "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" + } + ] } }, - "Tp": { - "Cd": "SHAR" - } - }, - "Dbtr": { - "Nm": "NAME", - "PstlAdr": { - "AdrTp": "ADDR", - "BldgNb": "BLDGNB", - "Ctry": "CTRY", - "TwnNm": "TWNNM", - "PstCd": "PSTCD", - "StrtNm": "STRTNM" - } - }, - "DbtrAcct": { - "Id": { - "IBAN": "IBAN" - } + "required": [ + "Cd" + ] }, - "DbtrAgt": { - "BrnchId": { - "Id": "BRANCHID" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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" + } + ] + } }, - "FinInstnId": { - "BICFI": "BICFI" - } - }, - "CdtrAgt": { - "BrnchId": { - "Id": "BRANCHID" + "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" + } + ] + } }, - "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 + "required": [ + "IlpV4PrepPacket" + ] }, - "Tax": "Cdtr" + { + "properties": { + "Sh256Sgntr": { + "allOf": [ + { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + { + "description": "SHA-256 signature of the terms\n" + } + ] + } + }, + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" } }, { - "description": "Credit Transfer Transaction Information\n" + "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" } ] } }, "required": [ - "GrpHdr", - "CdtTrfTxInf" + "PmtId", + "IntrBkSttlmAmt", + "UndrlygCstmrCdtTrf", + "Dbtr", + "Cdtr", + "VrfctnOfTerms", + "InstrForCdtrAgt" ], "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" - } + "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" } } }, - "TermsResponse_FIToFICustomerCreditConfirmation": { - "title": "TermsResponse_FIToFICustomerCreditConfirmation", + "FxResponse_FICreditTransferConfirmation": { + "title": "FxResponse_FICreditTransferConfirmation", "type": "object", - "description": "This message is sent by the initiating party to the executing party, directly or through one or more intermediaries, to confirm the credit transfer transaction.\n", + "description": "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": [ @@ -158985,230 +188679,6 @@ "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": [ @@ -159266,7 +188736,8 @@ "MsgId", "CreDtTm", "NbOfTxs", - "SttlmInf" + "SttlmInf", + "PmtInstrXpryDtTm" ], "example": { "MsgId": 12345, @@ -159290,14 +188761,14 @@ } }, { - "description": "Group Header\nSet of characteristics shared by all individual transactions included in the message.\n" + "description": "GroupHeader\nSet of characteristics shared by all individual transactions included in the message.\n" } ] }, "CdtTrfTxInf": { "allOf": [ { - "title": "CreditTransferTransaction67", + "title": "CreditTransferTransaction68_FX_Quotes", "description": "Provides further details specific to the individual transaction(s) included in the message.\n", "type": "object", "properties": { @@ -161830,116 +191301,1067 @@ } ] }, - "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" - } - ] + "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 } }, - "required": [ - "ChanlTp" - ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "OtherContact\nContact details in another form.\n" - } - ] - }, - "PrefrdMtd": { - "allOf": [ - { - "title": "PreferredContactMethod2Code", - "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", - "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "MAIL" - }, - { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "URLAdr": "http://www.example.com", - "EmailAdr": "example@example.com" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "Id" + "FinInstnId" ], "example": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" } - }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" } } }, { - "description": "Party to which an amount of money is due.\n" + "description": "Financial institution servicing an account for the debtor.\n" } ] }, - "DbtrAgt": { + "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", @@ -162886,197 +193308,1268 @@ } }, { - "description": "Financial institution servicing an account for the debtor.\n" + "description": "Financial institution servicing an account for the creditor.\n" + } + ] + } + }, + "required": [ + "Dbtr", + "Cdtr", + "DbtrAgt", + "CdtrAgt", + "InstdAmt" + ] + }, + { + "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 } ] }, - "CdtrAgt": { + "Ccy": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "ActiveCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" + } + ] + }, + "Dbtr": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "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": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "description": "Information used to identify a financial institution.\n", "properties": { - "FinInstnId": { + "BICFI": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + } + ] + }, + "ClrSysMmbId": { + "allOf": [ + { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", - "description": "Information used to identify a financial institution.\n", "properties": { - "BICFI": { + "ClrSysId": { "allOf": [ { - "title": "BICFIDec2014Identifier", + "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", - "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": "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" + ] }, { - "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": { + "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" } ] } @@ -163090,67 +194583,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" } ] } @@ -163161,90 +194602,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", @@ -163252,15 +194620,341 @@ "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "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", @@ -163268,204 +194962,501 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + { + "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" + ] }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nProprietary identification of the clearing system.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - }, + ], "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" + "Cd": "CHIPS" } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "Othr": { + "MmbId": { "allOf": [ { - "title": "GenericFinancialIdentification1", - "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + } + ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + { + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identifier of the financial institution.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { "properties": { - "Id": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "example": "ADDR" }, { - "description": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "Code\nType of address expressed as a code.\n" } ] - }, - "SchmeNm": { + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "GenericIdentification30", "type": "object", - "description": "Specifies the name of the identification scheme.\n", - "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": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" - } - ] + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" } - }, - "required": [ - "Prtry" ] } + }, + "required": [ + "Id", + "Issr" ], "example": { - "Cd": "BIC" + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } }, { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "Prtry" + ] } - ] - } - }, - "required": [], - "example": { - "BICFI": "J5BMVH7D", - "ClrSysMmbId": { - "ClrSysId": 1234, - "MmbId": 123 + ], + "example": { + "Cd": "ADDR" + } }, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": 123, - "Prtry": 123 - }, - "Issr": 123 + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "BrnchId": { + "Othr": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "GenericFinancialIdentification1", "type": "object", + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ @@ -163478,1635 +195469,945 @@ "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" } ] - } - }, - "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" - ] - } - ], - "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", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\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": { + "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": "Financial institution servicing an account for the creditor.\n" - } - ] - } - }, - "required": [ - "Dbtr", - "Cdtr", - "DbtrAgt", - "CdtrAgt" - ] - }, - { - "description": "Underlying Customer Credit Transfer\nTBD\n" - } - ] - }, - "IntrBkSttlmAmt": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount", - "type": "object", - "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", - "properties": { - "ActiveCurrencyAndAmount": { - "allOf": [ - { - "title": "ActiveCurrencyAndAmount_SimpleType", - "type": "string", - "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", - "example": 123.45 - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] + "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": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" } ] }, - "ChrgBr": { - "title": "ChargeBearerType1Code", - "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", - "type": "string", - "enum": [ - "DEBT", - "CRED", - "SHAR" - ], - "example": "DEBT" - }, - "ChrgsInf": { + "CdtrAgt": { "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" - } - ] - }, - "Agt": { - "allOf": [ - { - "title": "BranchAndFinancialInstitutionIdentification8", - "type": "object", - "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": [ - { - "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" - ] - }, + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "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" - ] + "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" } - ], - "example": { - "Cd": "CHIPS" - } - }, - { - "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + ] } + }, + "required": [ + "Cd" ] }, - "MmbId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nProprietary identification of the clearing system.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "MmbId" ], "example": { - "ClrSysId": { - "Cd": "CHQB" - }, - "MmbId": 123456789 + "Cd": "CHIPS" } }, { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "LEI": { + "MmbId": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "LEI\nLegal entity identifier of the financial institution.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - "Nm": { - "allOf": [ + "MmbId": 123456789 + } + }, + { + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + } + ] + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identifier of the financial institution.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "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": [ @@ -165119,1152 +196420,588 @@ "example": 1.234567890123457e+34 }, { - "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" - }, - { - "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "PstlAdr": { + "SchmeNm": { "allOf": [ { - "title": "PostalAddress27", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "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": "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": [ - "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" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - }, + ], "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" + "Cd": "BIC" } }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, + "required": [ + "Id" + ], "example": { "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "FinInstnId" - ], + "required": [], "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "BrnchId": { + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + }, + "Othr": { "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "Tp": { + "BrnchId": { "allOf": [ { - "title": "ChargeType3Choice", - "description": "ChargeType3Choice\nSpecifies the type of charge.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", - "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": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification3", + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[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": "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" + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + { + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "CASH" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "Type\nDefines the type of charges.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "Amt", - "Agt" + "FinInstnId" ], "example": { - "Amt": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Agt": { - "BrnchId": { - "Id": "BRANCHID" - }, - "FinInstnId": { - "BICFI": "BICFI" + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" } - }, - "Tp": { - "Cd": "SHAR" } } }, { - "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n" + "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, - "Dbtr": { + "Cdtr": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" - } - ] - }, - "PstlAdr": { + "FinInstnId": { "allOf": [ { - "title": "PostalAddress27", + "title": "FinancialInstitutionIdentification23", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "description": "Information used to identify a financial institution.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "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" - } - ] + "BICFI": { + "allOf": [ + { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } - }, - "required": [ - "OrgId" ] }, - { - "properties": { - "PrvtId": { - "allOf": [ - { - "title": "PersonIdentification18", - "description": "Unique and unambiguous way to identify a person.\n", - "type": "object", - "properties": { - "DtAndPlcOfBirth": { - "allOf": [ + "ClrSysMmbId": { + "allOf": [ + { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "allOf": [ + { + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", + "type": "object", + "anyOf": [ { - "title": "DateAndPlaceOfBirth1", - "description": "Details about date and place of birth of a person.\n", - "type": "object", "properties": { - "BirthDt": { - "allOf": [ - { - "title": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", - "type": "string", - "format": "date", - "example": "2013-03-07" - }, - { - "description": "BirthDate\nDate on which a person was born.\n" - } - ] - }, - "PrvcOfBirth": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "ProvinceOfBirth\nProvince where a person was born.\n" - } - ] - }, - "CityOfBirth": { + "Cd": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "CityOfBirth\nCity where a person was born.\n" - } - ] - }, - "CtryOfBirth": { - "allOf": [ - { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + "maxLength": 5, + "example": 12345 }, { - "description": "CountryOfBirth\nCountry where a person was born.\n" + "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" - ], - "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" - } + "Cd" + ] }, { - "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" - } - ] - }, - "Othr": { - "allOf": [ - { - "title": "GenericPersonIdentification2", - "type": "object", - "description": "Identification of a person.", "properties": { - "Id": { - "allOf": [ - { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 - }, - { - "description": "Identification\nUnique and unambiguous identification of a person.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "type": "object", - "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": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -166275,107 +197012,67 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "Prtry" + ] } - ] - } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 + ], + "example": { + "Cd": "CHIPS" } + }, + { + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } - } + ] }, - { - "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\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": [ - "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": { + "LEI": { "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": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a 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": "DOCT" + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, @@ -166390,95 +197087,432 @@ "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" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, - "URLAdr": { + "PstlAdr": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 + "title": "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": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "EmailAdr": { + "Othr": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 + "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": "EmailAddress\nAddress for electronic mail (e-mail).\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] + } + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "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" - } - ] + "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" }, - "JobTitl": { + "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", @@ -166489,172 +197523,370 @@ "example": 1.234567890123457e+34 }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "Rspnsblty": { + "LEI": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, - "Dept": { + "Nm": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "maxLength": 140, + "example": 12345 }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, - "Othr": { + "PstlAdr": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "PostalAddress27", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "ChanlTp": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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 }, - "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" - } - ] + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } }, - "required": [ - "ChanlTp" - ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "OtherContact\nContact details in another form.\n" - } - ] - }, - "PrefrdMtd": { - "allOf": [ - { - "title": "PreferredContactMethod2Code", - "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", - "type": "string", - "enum": [ - "LETT", - "MAIL", - "PHON", - "FAXX", - "CELL" - ], - "example": "MAIL" - }, - { - "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "URLAdr": "http://www.example.com", - "EmailAdr": "example@example.com" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "Id" + "FinInstnId" ], "example": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Id": { - "OrgId": { - "AnyBIC": "BIC" - }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" } - }, - "CtryOfRes": "BE", - "CtctDtls": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" } } }, { - "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", @@ -167173,1048 +198405,1583 @@ } }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + } + ] + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + { + "description": "CreditorAccount\nAccount to which a credit entry is made.\n" + } + ] + }, + "InstrForCdtrAgt": { + "allOf": [ + { + "title": "InstructionForCreditorAgent3_Put_FX_Quotes_ID", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalCreditorAgentInstruction1Code", + "description": "Specifies the instruction given by the creditor to the creditor agent.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" + } + ] + }, + "InstrInf": { + "allOf": [ + { + "title": "AmountTypeEnum", + "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", + "type": "string", + "enum": [ + "SEND", + "RECEIVE" + ], + "example": "SEND" + }, + { + "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" + } + ] + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + { + "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" + } + ] + }, + "Purp": { + "allOf": [ + { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", + "type": "object", + "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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + { + "description": "SHA-256 signature of the terms\n" + } + ] + } + }, + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + }, + { + "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" + } + ] + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "UndrlygCstmrCdtTrf", + "Dbtr", + "Cdtr", + "VrfctnOfTerms", + "InstrForCdtrAgt" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + } + }, + "IntrBkSttlmAmt": { + "Amount": 123.45, + "Ccy": "EUR" + }, + "Dbtr": { + "Nm": "Debtor Name" + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "Creditor Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "INSTRUCTION" + }, + "Purp": { + "Cd": "CHAR" + }, + "VrfctnOfTerms": { + "Cntt": "CONTENT", + "CnttTp": "PROPRIETARY" + } + } + }, + { + "description": "CreditTransferTransaction68_FX_Quotes\nSet of elements providing information specific to the individual credit transfer(s).\n" + } + ] + } + }, + "required": [ + "GrpHdr", + "CdtTrfTxInf" + ], + "example": { + "GrpHdr": { + "MsgId": "20191122-123456", + "CreDtTm": "2019-11-22T12:34:56", + "NbOfTxs": 1, + "CtrlSum": 100, + "InitgPty": { + "Nm": "Initiating Party Name" + }, + "MsgRcpt": { + "Nm": "Message Recipient Name" + } + }, + "CdtTrfTxInf": { + "PmtId": { + "InstrId": "20191122-123456", + "EndToEndId": "20191122-123456" + }, + "PmtTpInf": { + "InstrPrty": "NORM", + "CtgyPurp": "SUPP" + }, + "IntrBkSttlmAmt": { + "Amt": 100, + "Ccy": "EUR" + }, + "ChrgBr": "SHAR", + "Cdtr": { + "Nm": "Creditor Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account" + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "BNBABEBB" + } + }, + "CdtrAgtAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account" + }, + "Dbtr": { + "Nm": "Debtor Name" + }, + "DbtrAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account" + }, + "DbtrAgt": { + "FinInstnId": { + "BICFI": "BNBABEBB" + } + }, + "DbtrAgtAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account" + }, + "RmtInf": { + "Ustrd": "Remittance Information" + }, + "RgltryRptg": { + "Dbtr": { + "Nm": "Debtor Name" + }, + "DbtrAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account" + } + } + } + } + }, + "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": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "EndToEndId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "TxId": { + "allOf": [ + { + "title": "ULIDIdentifier", + "type": "string", + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" + }, + { + "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" + } + ] + }, + "UETR": { + "allOf": [ + { + "title": "UUIDv4Identifier", + "type": "string", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" + }, + { + "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" + } + ] + }, + "ClrSysRef": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" + } + ] + } + }, + "required": [ + "TxId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + { + "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" + } + ] + }, + "PmtTpInf": { + "allOf": [ + { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], "example": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" - }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 12345 - } + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "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": "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" } ] }, - "DbtrAgt": { + "Dbtr": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification8", + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", "type": "object", - "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "FinInstnId": { + "Nm": { "allOf": [ { - "title": "FinancialInstitutionIdentification23", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress27", "type": "object", - "description": "Information used to identify a financial institution.\n", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "BICFI": { - "allOf": [ - { - "title": "BICFIDec2014Identifier", - "type": "string", - "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - { - "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" - } - ] - }, - "ClrSysMmbId": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "ClearingSystemMemberIdentification2", - "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", - "type": "object", "properties": { - "ClrSysId": { + "Cd": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", - "type": "object", - "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" - } - ] - } - }, - "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 + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "BrnchId": { + "Id": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "title": "Party52Choice", + "description": "NOTE: Unsure on the description.\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", + "anyOf": [ + { + "properties": { + "OrgId": { + "allOf": [ + { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] + "properties": { + "AnyBIC": { + "allOf": [ + { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + { + "description": "AnyBIC\nBusiness identification code of the organisation.\n" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "GenericIdentification30", - "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[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" + } + ] }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\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" + } }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum 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": "SchemeName\nName of the identification scheme.\n" } - }, - "required": [ - "Id", - "Issr" - ], - "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" - } + ] }, - { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] } - ] + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "ADDR" + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } } }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "UnitNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "TwnLctnNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "DstrctNm": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + { + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } - }, - "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "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" + ] } + }, + "required": [ + "OrgId" ] }, - "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": { + "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": { - "Cd": { + "BirthDt": { "allOf": [ { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\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": 5, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nClearing system identification code, as published in an external list.\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": [ - "Cd" - ] + "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": { - "Prtry": { + "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", @@ -168225,67 +199992,107 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nProprietary identification of the clearing system.\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": "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": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" }, - { - "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } } - ] - } - }, - "required": [ - "MmbId" - ], - "example": { - "ClrSysId": { - "Cd": "CHQB" + } }, - "MmbId": 123456789 - } - }, - { - "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" + { + "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" + } + ] } + }, + "required": [ + "PrvtId" ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" }, - "LEI": { + "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": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "description": "Specifies the 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", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "example": "DOCT" }, { - "description": "LEI\nLegal entity identifier of the financial institution.\n" + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, @@ -168300,432 +200107,80 @@ "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": { + "PhneNb": { "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": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, - "Othr": { + "MobNb": { "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": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\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" + "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" + } + ] }, - "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": { + "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", @@ -168736,366 +200191,183 @@ "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": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" + "description": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, @@ -170011,232 +201283,825 @@ "example": 1.2345678901234567e+99 }, { - "description": "Department\nIdentification of a division of a large organisation or building.\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 + }, + { + "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": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\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": { - "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 person.\n" } ] }, - "Id": { + "SchmeNm": { "allOf": [ { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", + "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": 128, - "example": 12345 + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identifier\nCommunication value such as phone number or email address.\n" + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "ChanlTp" + "Id" ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "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": "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", - "URLAdr": "http://www.example.com", - "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": "Contact Details\nSet of elements used to indicate how to contact the party.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\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": { + "BrnchId": { "allOf": [ { - "title": "AccountIdentification4Choice", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\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": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } - }, - "required": [ - "IBAN" ] }, - { - "properties": { - "Othr": { - "allOf": [ - { - "title": "GenericAccountIdentification1", + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[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": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 - }, - { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] } + }, + "required": [ + "Cd" ] }, - "SchmeNm": { - "allOf": [ - { - "title": "AccountSchemeName1Choice", - "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "anyOf": [ + { + "properties": { + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalAccountIdentification1Code", - "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 4, + "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -170247,1291 +202112,610 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Prtry" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - ], - "example": { - "Cd": 1111 - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Id" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "Cd": "ADDR" } }, - { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" - } - ] - } - }, - "required": [ - "Othr" - ] - } - ], - "example": { - "IBAN": "BE71096123456769" - } - }, - { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" - } - ] - }, - "Tp": { - "allOf": [ - { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", - "type": "object", - "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", + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 140, + "example": 12345 }, - { - "description": "Code\nAccount type, in a coded form.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "CACC" - } - }, - { - "description": "Type\nSpecifies the nature, or use of the account.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - { - "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" - } - ] - }, - "Prxy": { - "allOf": [ - { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", - "type": "object", - "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" - ] + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nProxy account type, in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "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 + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "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": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, + "required": [ + "FinInstnId" + ], "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" - ] + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\n\nPurpose, in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "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": "CH03" } }, { - "description": "Purpose\nUnderlying reason for the payment transaction.\n" + "description": "Financial institution servicing an account for the debtor.\n" } ] }, - "RgltryRptg": { + "CdtrAgt": { "allOf": [ { - "title": "RegulatoryReporting3", - "description": "Information needed due to regulatory and/or 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": { - "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": { + "FinInstnId": { "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", + "title": "FinancialInstitutionIdentification23", "type": "object", + "description": "Information used to identify 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": { + "BICFI": { "allOf": [ { - "title": "Max10Text", - "description": "Specifies a character string with a maximum length of 10 characters.\n", + "title": "BICFIDec2014Identifier", "type": "string", - "minLength": 1, - "maxLength": 10, - "example": 1234567890 + "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 the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\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" } ] }, - "Amt": { + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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" + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "Inf": { - "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", - "anyOf": [ + "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", + "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": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, { - "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": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] - } - }, - "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})$" + "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": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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" - } - }, - { - "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": { + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -171539,124 +202723,230 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - "type": "array" + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } - ] - } - }, - "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" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "TaxTp": { + "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": "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": "TaxType\n\nType of tax payer.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, + "required": [], "example": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT" + "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": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "Dbtr": { + "BrnchId": { "allOf": [ { - "title": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "properties": { - "TaxId": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -171667,142 +202957,693 @@ "example": 1.234567890123457e+34 }, { - "description": "TaxIdentification\n\nTax identification number of the debtor.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "RegnId": { + "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": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, - "TaxTp": { + "Nm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "maxLength": 140, + "example": 12345 }, { - "description": "TaxType\n\nType of tax payer.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, - "Authstn": { + "PstlAdr": { "allOf": [ { - "title": "TaxAuthorisation1", - "description": "Details of an authorised tax paying party.\n", + "title": "PostalAddress27", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "Titl": { - "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": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\n\nName of the debtor or the debtor's authorised representative.\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": { - "Titl": "Mr", - "Nm": "John Doe" + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "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": "Authorisation\n\nDetails of the authorised tax paying party.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT", - "Authstn": { - "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": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "UltmtDbtr": { + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + { + "description": "Financial institution servicing an account for the creditor.\n" + } + ] + } + }, + "required": [ + "Dbtr", + "Cdtr", + "DbtrAgt", + "CdtrAgt", + "InstdAmt" + ] + }, + { + "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", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" + } + ] + }, + "Dbtr": { + "allOf": [ + { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "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": "TaxParty2", - "description": "Details about the entity involved in the tax paid or to be paid.\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": { - "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": { + "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": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "TaxTp": { + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -171813,90 +203654,41 @@ "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" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, + "required": [ + "MmbId" + ], "example": { - "TaxId": 123456789, - "RegnId": 123456789, - "TaxTp": "VAT", - "Authstn": { - "Titl": "Mr", - "Nm": "John Doe" - } + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 } }, { - "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, - "AdmstnZone": { + "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": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, - "RefNb": { + "Nm": { "allOf": [ { "title": "Max140Text", @@ -171907,1908 +203699,1445 @@ "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" + "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": "PostalAddress24", "type": "object", - "description": "A number 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": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\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": "Currency\nIdentification of the currency in which the account is held.\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": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, - "TtlTaxAmt": { + "Othr": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyAndAmount", + "title": "GenericFinancialIdentification1", "type": "object", - "description": "A number 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": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\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 person.\n" } ] }, - "Ccy": { + "SchmeNm": { "allOf": [ { - "title": "ActiveOrHistoricCurrencyCode", + "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", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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" } ] } }, "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" + "Id" ], "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] + } + }, + "required": [], + "example": { + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "Dt": { + "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": "ISODate", - "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "format": "date", - "example": "2013-03-07" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Date\n\nDate by which tax is due.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "SeqNb": { + "LEI": { "allOf": [ { - "title": "Number", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a 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": 256, - "pattern": "^(?!0\\d)\\d{1,18}$" + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "SequenceNumber\n\nSequential number of the tax report.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, - "Rcrd": { - "description": "Record\n\nDetails of the tax record.\n", - "anyOf": [ + "Nm": { + "allOf": [ { - "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": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "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": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" - } - ] - }, - "TtlAmt": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyAndAmount", - "type": "object", - "description": "A number of monetary 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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] + "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" - } - } - }, - { - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } + } + }, + "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": "Amount\n\nUnderlying tax amount related to the specified period.\n" + "description": "Code\nName of the identification scheme, 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" - } - } + "Cd" + ] }, { - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" - } - ] - } + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "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 }, - "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" } - }, - "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\nProprietary identification of the clearing system.\n" + } + ] + } }, - "Inf": 12345 + "required": [ + "Prtry" + ] } + ], + "example": { + "Cd": "CHIPS" } }, { - "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "Tp": { + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -173819,2847 +205148,3764 @@ "example": 1.234567890123457e+34 }, { - "description": "Type\n\nHigh level code to identify the type of tax details.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, + "required": [ + "MmbId" + ], "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 - } + "ClrSysId": { + "Cd": "CHQB" }, - "AddtlInf": "VAT applicable" + "MmbId": 123456789 } }, { - "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": "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": "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": [ + "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": [ - "FrDt", - "ToDt" - ], - "example": { - "FrDt": "2022-01-01", - "ToDt": "2022-12-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 + }, + { + "description": "SchemeName\nShort textual description of the 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" + "required": [ + "Id", + "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" + } + ] + } }, - "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" - } + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "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": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" + ], + "example": { + "Cd": "BIC" } - ] - }, - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "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" + } + ] }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum 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": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" + "required": [ + "Id", + "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" + } + ] + } }, - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "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": "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" - } - ] - } + "required": [ + "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" + } + ] }, - "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" } - }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" - } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\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": [ + "Id", + "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 }, - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] - } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" - } - }, - { - "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" - } - ] + { + "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 }, - "Amt": { - "Amt": 100, - "Ccy": "EUR" + { + "description": "Issuer\nEntity that assigns the identification.\n" } - } + ] }, - "type": "array" + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" } - ] - } - }, - "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": "Proprietary\nType of address expressed as a proprietary 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 - }, - { - "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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", - "type": "string", - "pattern": "^[A-Za-z0-9-_]{43}$", - "maxLength": 48 - }, - { - "description": "SHA-256 signature of the terms\n" - } - ] - } - }, - "required": [ - "Sh256Sgntr" - ] - } - ], - "example": { - "IlpV4PrepPacket": "1234567890ABCDEF" - } } }, "required": [ - "PmtId", - "IntrBkSttlmAmt", - "ChrgBr", - "Dbtr", - "DbtrAgt", - "CdtrAgt", - "Cdtr" + "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" - } - } - } - } - }, - "ULIDIdentifier": { - "title": "ULIDIdentifier", - "type": "string", - "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", - "example": "01AN4Z07BY79KA1307SR9X4MV3" - }, - "UUIDv4Identifier": { - "title": "UUIDv4Identifier", - "type": "string", - "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" - }, - "UnderlyingCustomerCreditTransfer": { - "title": "UnderlyingCustomerCreditTransfer", - "type": "object", - "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\n" - } - ] } - }, - "required": [ - "ActiveOrHistoricCurrencyAndAmount", - "Ccy" - ], - "example": { - "ActiveOrHistoricCurrencyAndAmount": 123.45, - "Ccy": "USD" } }, { - "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, - "Dbtr": { + "Cdtr": { "allOf": [ { - "title": "PartyIdentification272", - "description": "Specifies the identification of a person or an organisation.\n", + "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" - } - ] - }, - "PstlAdr": { + "FinInstnId": { "allOf": [ { - "title": "PostalAddress27", + "title": "FinancialInstitutionIdentification23", "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "description": "Information used to identify a financial institution.\n", "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "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": { + "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": { - "Cd": { + "Id": { "allOf": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "example": "ADDR" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "SchmeNm": { "allOf": [ { - "title": "GenericIdentification30", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] } + }, + "required": [ + "Cd" ] }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Id", - "Issr" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Cd": "BIC" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "SchemeName\nName of the identification scheme.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ - "Prtry" - ] + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } - ], - "example": { - "Cd": "ADDR" - } - }, - "CareOf": { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "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": [], "example": { - "AdrTp": "ADDR", - "CareOf": "CareOf", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "UnitNb": "UnitNb", - "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": "Postal Address\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" } ] }, - "Id": { + "BrnchId": { "allOf": [ { - "title": "Party52Choice", - "description": "NOTE: Unsure on the description.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", - "anyOf": [ - { - "properties": { - "OrgId": { - "allOf": [ - { - "title": "OrganisationIdentification39", - "description": "Unique and unambiguous way to identify 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\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", - "properties": { - "AnyBIC": { - "allOf": [ - { - "title": "AnyBICDec2014Identifier", - "type": "string", - "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - { - "description": "AnyBIC\nBusiness identification code of the organisation.\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" - }, - { - "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] } + }, + "required": [ + "Cd" ] }, - "Othr": { - "allOf": [ - { - "title": "GenericOrganisationIdentification3", - "type": "object", - "description": "Information related to an identification of an organisation.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 - }, - { - "description": "Identification\nIdentification assigned by an institution.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", - "type": "object", - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" - } - ] + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" - } - ] + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } - }, - "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" + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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": [ - "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" - } + } + }, + "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": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" + "description": "Identification\nIdentification assigned by an institution.\n" } ] }, - "Othr": { + "SchmeNm": { "allOf": [ { - "title": "GenericPersonIdentification2", + "title": "AccountSchemeName1Choice", "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": [ + "description": "Sets of elements to identify a name of the identification scheme.\n", + "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": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 }, { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } - ], - "example": { - "Cd": "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": 1111 } }, { - "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": "IBAN" }, - "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 an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ - "PrvtId" + "Othr" ] } ], "example": { - "OrgId": { - "AnyBIC": "BIC" + "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" + ] }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "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": "Identification\nUnique and unambiguous identification of a party.\n" + "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, - "CtryOfRes": { + "Ccy": { "allOf": [ { - "title": "CountryCode", + "title": "ActiveOrHistoricCurrencyCode", "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "Country of Residence\nCountry in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n" + "description": "Currency\nIdentification of the currency in which the account is held.\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" } ] }, - "CtctDtls": { + "Nm": { "allOf": [ { - "title": "Contact13", - "description": "Specifies the details of the contact person.\n", + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", "type": "object", "properties": { - "NmPrfx": { + "Tp": { "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": "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" + ] + } ], - "type": "string", - "example": "DOCT" + "example": { + "Cd": "EMAIL" + } }, { - "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" + "description": "Type\nType of the proxy identification.\n" } ] }, - "Nm": { + "Id": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "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\nName by which a party is known and which is usually used to identify that party.\n" + "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" }, - "PhneNb": { - "allOf": [ - { - "title": "PhoneNumber", - "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + "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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + { + "description": "SHA-256 signature of the terms\n" + } + ] + } + }, + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + }, + { + "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" + } + ] + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "Dbtr", + "Cdtr", + "UndrlygCstmrCdtTrf", + "VrfctnOfTerms" + ], + "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" + } + } + }, + "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" + } + }, + "required": [ + "SttlmMtd" + ], + "example": { + "SttlmMtd": "INDA", + "PmtTpInf": { + "InstrPrty": "NORM", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CH03" + }, + "CtgyPurp": { + "Cd": "SUPP" + }, + "Cdtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "AdrLine": "Address", + "Ctry": "CH" }, - { - "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + "Id": { + "OrgId": { + "AnyBIC": "BIC", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN", + "Issr": "BIC" + } + } + } + }, + "CtryOfRes": "CH", + "CtctDtls": { + "Nm": "Name", + "PhneNb": 123, + "EmailAdr": null } - ] - }, - "MobNb": { + } + } + } + }, + { + "description": "Settlement Information\n" + } + ] + } + }, + "required": [ + "MsgId", + "CreDtTm", + "NbOfTxs", + "SttlmInf", + "PmtInstrXpryDtTm" + ], + "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": "PhoneNumber", + "title": "ULIDIdentifier", "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { - "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\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\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, - "FaxNb": { + "EndToEndId": { "allOf": [ { - "title": "PhoneNumber", + "title": "ULIDIdentifier", "type": "string", - "description": "Double check this regex.\n", - "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { - "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\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\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, - "URLAdr": { + "TxId": { "allOf": [ { - "title": "Max2048Text", - "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "title": "ULIDIdentifier", "type": "string", - "minLength": 1, - "maxLength": 2048, - "example": 2048 + "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", + "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { - "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\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\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, - "EmailAdr": { + "UETR": { "allOf": [ { - "title": "Max256Text", - "description": "Specifies a character string with a maximum length of 256 characters.\n", + "title": "UUIDv4Identifier", "type": "string", - "minLength": 1, - "maxLength": 256, - "example": 256 + "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": "EmailAddress\nAddress for electronic mail (e-mail).\n" + "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" } ] }, - "EmailPurp": { + "ClrSysRef": { "allOf": [ { "title": "Max35Text", @@ -176670,271 +208916,1337 @@ "example": 1.234567890123457e+34 }, { - "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + "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" }, - "JobTitl": { + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalServiceLevel1Code", + "description": "Specifies the external service level code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, - "Rspnsblty": { + "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": "Responsibility\nRole of a person in an organisation.\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" } ] }, - "Dept": { + "CtgyPurp": { "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": "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": "Department\nIdentification of a division of a large organisation or building.\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" }, - "Othr": { + "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": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\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": { - "ChanlTp": { + "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\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" + } + ] + }, + "Ccy": { + "allOf": [ + { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\n" + } + ] + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + { + "description": "InstructedAmount\nAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n" + } + ] + }, + "Dbtr": { + "allOf": [ + { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "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": "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": "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": { - "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": { + "CtryOfRes": { "allOf": [ { - "description": "AddressType2Code\nSpecifies 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": "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": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a 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", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "example": "DOCT" }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, - "Issr": { + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PhneNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + } + ] + }, + "MobNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + } + ] + }, + "FaxNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + } + ] + }, + "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", @@ -176945,11 +210257,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", @@ -176960,1177 +210272,1315 @@ "example": 1.234567890123457e+34 }, { - "description": "SchemeName\nShort textual description of the scheme.\n" + "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" } ] } }, - "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": "Party that owes an amount of money to the (ultimate) creditor.\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", + "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", - "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": 16, + "example": 1234567890123456 }, - { - "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", + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" + "minLength": 1, + "maxLength": 140, + "example": 12345 }, - { - "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "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": "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": { + "OrgId": { "allOf": [ { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "properties": { - "Cd": { + "AnyBIC": { "allOf": [ { - "title": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation 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" } ] }, - "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" } ] - } - }, - "anyOf": [ - { - "properties": { - "Cd": {} - } }, - { - "properties": { - "Prtry": {} - } + "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": { - "Cd": "BIC" + "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" - } - ] - } - }, - "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" + "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ - "BirthDt", - "CityOfBirth", - "CtryOfBirth" - ], - "example": { - "BirthDt": "1970-01-01", - "PrvcOfBirth": "ON", - "CityOfBirth": "Ottawa", - "CtryOfBirth": "CA" - } + "OrgId" + ] }, { - "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": { + "PrvtId": { "allOf": [ { - "title": "PersonIdentificationSchemeName1Choice", - "description": "Sets of elements to identify a name of the identification scheme.\n", + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalPersonIdentification1Code", - "description": "Specifies the external person identification code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "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": "Code\nName of the identification scheme, in a coded form as published in an external list.\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": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "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": "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": "Proprietary\nName of the identification scheme, in a free text form.\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": [ - "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 + }, + "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": "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": { + }, + "CtctDtls": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "title": "Contact13", + "description": "Specifies the details of the contact person.\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": { + "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" } - }, - "required": [ - "Cd" ] }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" + } + ] + }, + "PhneNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" + } + ] + }, + "MobNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" + } + ] + }, + "FaxNb": { + "allOf": [ + { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + { + "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" + } + ] + }, + "URLAdr": { + "allOf": [ + { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + { + "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" + } + ] + }, + "EmailAdr": { + "allOf": [ + { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + { + "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" + } + ] + }, + "EmailPurp": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "EmailPurpose\nPurpose for which an email address may be used.\n" + } + ] + }, + "JobTitl": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "JobTitle\nTitle of the function.\n" + } + ] + }, + "Rspnsblty": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Responsibility\nRole of a person in an organisation.\n" + } + ] + }, + "Dept": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Department\nIdentification of a division of a large organisation or building.\n" + } + ] + }, + "Othr": { + "allOf": [ + { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "allOf": [ + { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + } + ] }, - { - "description": "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": [ + "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" } - }, - "required": [ - "Prtry" ] } - ], + }, "example": { - "Cd": "CHIPS" + "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": "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": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ - "MmbId" + "Id" ], "example": { - "ClrSysId": { - "Cd": "CHQB" + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" }, - "MmbId": 123456789 + "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": "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" + "description": "Party to which an amount of money is due.\n" } ] }, - "PstlAdr": { + "DbtrAgt": { "allOf": [ { - "title": "PostalAddress24", + "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": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { + "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": "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" } ] }, - "SchmeNm": { + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -178141,236 +211591,206 @@ "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" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "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.", + }, + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,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": 4, - "example": 1234 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", @@ -178378,224 +211798,194 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ] - } - }, - "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" + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "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\nType of address expressed as a code.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Othr": { "allOf": [ { - "title": "GenericIdentification30", + "title": "GenericFinancialIdentification1", "type": "object", - "description": "Generic scheme identification for a party.\n", + "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, - "Issr": { + "SchmeNm": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "title": "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": "Issuer\nEntity that assigns the identification.\n" + "description": "SchemeName\nName of the identification scheme.\n" } ] }, - "SchmeNm": { + "Issr": { "allOf": [ { "title": "Max35Text", @@ -178606,467 +211996,871 @@ "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": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "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 + } + } + }, + { + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\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" - } - ] - } - }, - "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": { + "BrnchId": { "allOf": [ { - "title": "ClearingSystemIdentification2Choice", - "description": "Specifies the clearing system identification.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalClearingSystemIdentification1Code", - "description": "Specifies the external clearing system identification code.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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": 5, + "maxLength": 140, "example": 12345 }, - { - "description": "Code\nClearing system identification code, as published in an external list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "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": "Proprietary\nProprietary identification of the clearing system.\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 } - ] + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "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": "CHIPS" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "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": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "MmbId" + "FinInstnId" ], "example": { - "ClrSysId": { - "Cd": "CHQB" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "MmbId": 123456789 + "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": "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" + "description": "Financial institution servicing an account for the debtor.\n" } ] }, - "PstlAdr": { + "CdtrAgt": { "allOf": [ { - "title": "PostalAddress24", + "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", + "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", - "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": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" }, - "Issr": { + "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", @@ -179077,11 +212871,72 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { + "allOf": [ + { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalFinancialInstitutionIdentification1Code", + "description": "Specifies the external financial institution identification code.", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + { + "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + } + ] + } + }, + "required": [ + "Cd" + ] + }, + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 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", @@ -179092,236 +212947,346 @@ "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": "IBAN" + }, + "Issr": "BIC" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" - }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" - } - }, - { - "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" - } - ] - }, - "Othr": { - "allOf": [ - { - "title": "GenericFinancialIdentification1", - "type": "object", - "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "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": "Identification\nUnique and unambiguous identification of a person.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "SchmeNm": { + "BrnchId": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\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.", + "properties": { + "Id": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a 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": 4, - "example": 1234 + "maxLength": 70, + "example": 1.2345678901234567e+99 }, - { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "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", @@ -179329,1279 +213294,797 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Proprietary\nName of the identification scheme, in a free text 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": "BIC" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "Id" + "FinInstnId" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Issr": "BIC" + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } } }, { - "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" + "description": "Financial institution servicing an account for the creditor.\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": [ + "Dbtr", + "Cdtr", + "DbtrAgt", + "CdtrAgt", + "InstdAmt" + ] }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" + "description": "Underlying Customer Credit Transfer\nTBD\n" } ] }, - "BrnchId": { + "IntrBkSttlmAmt": { "allOf": [ { - "title": "BranchData5", - "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "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": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": { + "ActiveCurrencyAndAmount": { "allOf": [ { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated 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": "ActiveCurrencyAndAmount_SimpleType", "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" + "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\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 } ] }, - "Nm": { + "Ccy": { "allOf": [ { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", + "title": "ActiveCurrencyCode", "type": "string", - "minLength": 1, - "maxLength": 140, - "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": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] }, { - "description": "PostalAddress\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": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], "example": { - "Id": 123, - "LEI": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number" - } + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" } }, { - "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" - } - ] - } - }, - "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - } - }, - { - "description": "Financial institution servicing an account for the creditor.\n" - } - ] - } - }, - "required": [ - "Dbtr", - "Cdtr", - "DbtrAgt", - "CdtrAgt" - ] - }, - "VerificationReason1Choice": { - "title": "VerificationReason1Choice", - "type": "object", - "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalVerificationReason1Code", - "description": "Specifies the external verification reason code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "AGNT" - } - }, - "VerificationReport4": { - "title": "VerificationReport4", - "type": "object", - "description": "VerificationReport\nProvides information about the verification of party and/or account identification information.", - "properties": { - "OrgnlId": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "OriginalIdentification\nUnique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message.\n" - } - ] - }, - "Vrfctn": { - "allOf": [ - { - "title": "IdentificationVerificationIndicator", - "type": "boolean", - "example": true, - "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n" - }, - { - "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n" - } - ] - }, - "Rsn": { - "allOf": [ - { - "title": "VerificationReason1Choice", - "type": "object", - "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalVerificationReason1Code", - "description": "Specifies the external verification reason code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n" - } - ] + "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed 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\nReason why the verified identification information is incorrect, in a free text form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "AGNT" - } - }, - { - "description": "Reason\nSpecifies the reason why the verified identification information is incorrect.\n" - } - ] - }, - "OrgnlPtyAndAcctId": { - "allOf": [ - { - "title": "IdentificationInformation4", - "type": "object", - "description": "Information that locates and identifies a specific party or account.\n", - "properties": { - "Pty": { - "allOf": [ - { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "properties": { - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 140, - "example": 12345 - }, - { - "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" - } - ] - }, - "PstlAdr": { - "allOf": [ - { - "title": "PostalAddress24", - "type": "object", - "description": "Information that locates and identifies a specific address, as defined by postal services.\n", - "properties": { - "AdrTp": { - "title": "AddressType3Choice", - "type": "object", - "description": "Choice of formats for the type of address.\n", - "anyOf": [ - { - "properties": { - "Cd": { - "allOf": [ - { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], - "type": "string", - "example": "ADDR" - }, - { - "description": "Code\nType of address expressed as a code.\n" - } - ] - } - }, - "required": [ - "Cd" - ] + "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": { - "Prtry": { + "ClrSysId": { "allOf": [ { - "title": "GenericIdentification30", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\n", "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "title": "ExternalClearingSystemIdentification1Code", + "description": "Specifies the external clearing system identification code.\n", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + { + "description": "Code\nClearing system identification code, as published in an external list.\n" + } + ] } + }, + "required": [ + "Cd" ] }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Proprietary\nProprietary identification of the clearing system.\n" + } + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Id", - "Issr" ], "example": { - "Id": 1234, - "Issr": "BIC", - "SchmeNm": "BICFI" + "Cd": "CHIPS" } }, { - "description": "Proprietary\nType of address expressed as a proprietary code.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" + } + ] + }, + "MmbId": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "Prtry" - ] + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + { + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } - ], - "example": { - "Cd": "ADDR" - } - }, - "Dept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "SubDept": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "BldgNb": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "BldgNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "Flr": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstBx": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "Room": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - "PstCd": { - "title": "Max16Text", - "description": "Specifies a character string with a maximum length of 16 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 16, - "example": 1234567890123456 - }, - "TwnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "TwnLctnNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - "DstrctNm": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + ] }, - "CtrySubDvsn": { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "LEI": { + "allOf": [ + { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + { + "description": "LEI\nLegal entity identifier of the financial institution.\n" + } + ] }, - "Ctry": { - "title": "CountryCode", - "type": "string", - "pattern": "^[A-Z]{2,2}$", - "example": "US", - "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + "Nm": { + "allOf": [ + { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + { + "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" + } + ] }, - "AdrLine": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - } - }, - "example": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "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", + "PstlAdr": { + "allOf": [ + { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "properties": { - "AnyBIC": { - "allOf": [ - { - "title": "AnyBICDec2014Identifier", - "type": "string", - "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", - "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", - "example": "J5BMVH7D" - }, - { - "description": "AnyBIC\nBusiness identification code of the organisation.\n" - } - ] - }, - "LEI": { - "allOf": [ - { - "title": "LEIIdentifier", - "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", - "type": "string", - "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", - "example": "529900T8BM49AURSDO55" - }, - { - "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] } + }, + "required": [ + "Cd" ] }, - "Othr": { - "allOf": [ - { - "title": "GenericOrganisationIdentification1", - "type": "object", - "description": "Information that locates and identifies an organisation.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "OrganisationIdentificationSchemeName1Choice", - "description": "Choice of format for the organisation identification.\n", - "type": "object", - "properties": { - "Cd": { - "allOf": [ - { - "title": "ExternalOrganisationIdentification1Code", - "description": "Specifies the external organisation identification code.", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" - } - ] + { + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 }, - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" - } - ] + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } - }, - "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": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a 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": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -180612,195 +214095,102 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "DRLC" - }, - "Issr": "BIC" - } - }, - { - "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" + "Prtry" + ] } - ] - } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - }, - "Othr": { - "Id": 123, - "SchmeNm": { - "Cd": "CUST", - "Prtry": 1 + ], + "example": { + "Cd": "BIC" } + }, + { + "description": "SchemeName\nName of the identification scheme.\n" } - } + ] }, - { - "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] } - ] + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } - }, - "required": [ - "PrvtId" ] } - ], + }, + "required": [], "example": { - "OrgId": { - "AnyBIC": "BIC" + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "Identification\nUnique and unambiguous 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" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "CtctDtls": { + "BrnchId": { "allOf": [ { - "title": "Contact4", - "description": "Specifies the details of the contact person.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "properties": { - "NmPrfx": { - "allOf": [ - { - "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", - "enum": [ - "DOCT", - "MADM", - "MISS", - "MIST", - "MIKS" - ], - "type": "string", - "example": "DOCT" - }, - { - "description": "NamePrefix\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": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -180811,177 +214201,370 @@ "example": 1.234567890123457e+34 }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "Rspnsblty": { + "LEI": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, - "Dept": { + "Nm": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "maxLength": 140, + "example": 12345 }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, - "Othr": { + "PstlAdr": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "PostalAddress27", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "ChanlTp": { - "allOf": [ + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "anyOf": [ { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] + } + }, + "required": [ + "Cd" + ] }, { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" + "properties": { + "Prtry": { + "allOf": [ + { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", + "properties": { + "Id": { + "allOf": [ + { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + { + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" + } + ] + }, + "Issr": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" + } + ] + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" + } + ] + } + }, + "required": [ + "Prtry" + ] } - ] + ], + "example": { + "Cd": "ADDR" + } }, - "Id": { - "allOf": [ - { - "title": "Max128Text", - "description": "Specifies a character string with a maximum length of 128 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 128, - "example": 12345 - }, - { - "description": "Identifier\nCommunication value such as phone number or email address.\n" - } - ] + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } }, - "required": [ - "ChanlTp" - ], "example": { - "ChanlTp": "PHON", - "Id": 1234567890 + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" } }, { - "description": "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": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { - "NmPrfx": "Mr", - "Nm": "John Doe", - "PhneNb": "+123-123-321", - "MobNb": "+123-123-321", - "FaxNb": "+123-123-321", - "EmailAdr": "example@example.com" + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ - "Id" + "FinInstnId" ], "example": { - "Nm": "John Doe", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Dept", - "SubDept": "SubDept", - "StrtNm": "StrtNm", - "BldgNb": "BldgNb", - "BldgNm": "BldgNm", - "Flr": "Flr", - "PstBx": "PstBx", - "Room": "Room", - "PstCd": "PstCd", - "TwnNm": "TwnNm", - "TwnLctnNm": "TwnLctnNm", - "DstrctNm": "DstrctNm", - "CtrySubDvsn": "CtrySubDvsn", - "Ctry": "Ctry", - "AdrLine": "AdrLine" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Id": { - "OrgId": { - "Othr": { - "Id": 123, - "SchmeNm": { - "Prtry": "DfspId" - } - } + "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": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" + "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" } ] }, - "Acct": { + "DbtrAcct": { "allOf": [ { "title": "CashAccount40", @@ -181520,21 +215103,21 @@ } }, { - "description": "Account\nUnambiguous identification of the account of a party.\n" + "description": "DebtorAccount\nAccount used to process a payment.\n" } ] }, - "Agt": { + "DbtrAgt": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification6", + "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": "FinancialInstitutionIdentification18", + "title": "FinancialInstitutionIdentification23", "type": "object", "description": "Information used to identify a financial institution.\n", "properties": { @@ -181548,7 +215131,7 @@ "example": "J5BMVH7D" }, { - "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, @@ -181815,12 +215398,485 @@ "example": 1.2345678901234567e+99 }, "StrtNm": { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\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 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "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": 70, - "example": 1.2345678901234567e+99 + "maxLength": 140, + "example": 12345 }, "BldgNb": { "title": "Max16Text", @@ -181831,12 +215887,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", @@ -181846,6 +215902,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", @@ -181871,28 +215935,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", @@ -181920,12 +215984,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", @@ -181941,50 +216007,113 @@ "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" + } + ] }, - "Othr": { + "ClrSysMmbId": { "allOf": [ { - "title": "GenericFinancialIdentification1", + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\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": { + "ClrSysId": { "allOf": [ { - "title": "FinancialIdentificationSchemeName1Choice", + "title": "ClearingSystemIdentification2Choice", + "description": "Specifies the clearing system identification.\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": "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" } ] } @@ -182006,7 +216135,7 @@ "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" } ] } @@ -182017,15 +216146,15 @@ } ], "example": { - "Cd": "BIC" + "Cd": "CHIPS" } }, { - "description": "SchemeName\nName of the identification scheme.\n" + "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, - "Issr": { + "MmbId": { "allOf": [ { "title": "Max35Text", @@ -182036,83 +216165,23 @@ "example": 1.234567890123457e+34 }, { - "description": "Issuer\nEntity that assigns the identification.\n" + "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ - "Id" + "MmbId" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" + "ClrSysId": { + "Cd": "CHQB" }, - "Issr": "BIC" + "MmbId": 123456789 } }, { - "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" + "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, @@ -182126,7 +216195,7 @@ "example": "529900T8BM49AURSDO55" }, { - "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" + "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, @@ -182141,7 +216210,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" } ] }, @@ -182403,613 +216472,64 @@ } }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] - } - }, - "example": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - }, - { - "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" - } - ] - } - }, - "required": [ - "FinInstnId" - ], - "example": { - "FinInstnId": { - "BICFI": "J5BMVH7D" - }, - "BrnchId": { - "Id": 123, - "Nm": "Name", - "PstlAdr": { - "AdrTp": "ADDR", - "Dept": "Department", - "SubDept": "Sub department", - "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" - } - } - } - }, - { - "description": "Agent\nFinancial institution servicing an account for a party.\n" - } - ] - } - }, - "required": [ - "Pty" - ], - "example": { - "Pty": { - "Id": { - "OrgId": { - "AnyBIC": { - "BICFI": "BICFI" - } - } - }, - "CtryOfRes": "FI" - }, - "Acct": { - "Id": { - "IBAN": "FI2112345600000785" - } - }, - "Agt": { - "FinInstnId": { - "BICFI": "BICFI" - } - } - } - }, - { - "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n" - } - ] - }, - "UpdtdPtyAndAcctId": { - "allOf": [ - { - "title": "IdentificationInformation4", - "type": "object", - "description": "Information that locates and identifies a specific party or account.\n", - "properties": { - "Pty": { - "allOf": [ - { - "title": "PartyIdentification135", - "description": "Specifies the identification of a person or an organisation.\n", - "type": "object", - "properties": { - "Nm": { - "allOf": [ - { - "title": "Max140Text", - "description": "Specifies a character string with a maximum length of 140 characters.\n", - "type": "string", - "minLength": 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": [ + }, + "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": [ { - "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", - "enum": [ - "ADDR", - "PBOX", - "HOME", - "BIZZ", - "MLTO", - "DLVY" - ], + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", - "example": "ADDR" + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 }, { - "description": "Code\nType of address expressed as a code.\n" + "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "SchmeNm": { "allOf": [ { - "title": "GenericIdentification30", + "title": "FinancialIdentificationSchemeName1Choice", "type": "object", - "description": "Generic scheme identification for a party.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Exact4AlphaNumericText", - "description": "Specifies an alphanumeric string with a length of 4 characters.\n", - "type": "string", - "pattern": "^[a-zA-Z0-9]{4}$", - "example": 1234 - }, - { - "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" - } - ] - }, - "SchmeNm": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "SchemeName\nShort textual description of the scheme.\n" - } - ] - } - }, - "required": [ - "Id", - "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": [ + "description": "Specifies the name of the identification scheme.\n", + "anyOf": [ { - "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": { + "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 + "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" } ] } }, "required": [ - "Id" - ], - "example": { - "Id": 123, - "SchmeNm": { - "Cd": "BIC" - }, - "Issr": "BIC" - } + "Cd" + ] }, { - "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": { + "Prtry": { "allOf": [ { "title": "Max35Text", @@ -183020,325 +216540,102 @@ "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" + "description": "Proprietary\nName of the identification scheme, in a free text form.\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" + "Prtry" + ] } - ] + ], + "example": { + "Cd": "BIC" + } }, - "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" - } - ] + { + "description": "SchemeName\nName of the identification scheme.\n" } - }, - "example": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" + ] + }, + "Issr": { + "allOf": [ + { + "title": "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": "Issuer\nEntity that assigns the identification.\n" } - } - }, - { - "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" + ] } - ] + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + { + "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } - }, - "required": [ - "PrvtId" ] } - ], + }, + "required": [], "example": { - "OrgId": { - "AnyBIC": "BIC" + "BICFI": "J5BMVH7D", + "ClrSysMmbId": { + "ClrSysId": 1234, + "MmbId": 123 }, - "PrvtId": { - "DtAndPlcOfBirth": { - "Dt": "2018-01-01", - "CityOfBirth": "City" - } + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": 123, + "Prtry": 123 + }, + "Issr": 123 } } }, { - "description": "Identification\nUnique and unambiguous 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" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, - "CtctDtls": { + "BrnchId": { "allOf": [ { - "title": "Contact4", - "description": "Specifies the details of the contact person.\n", + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "properties": { - "NmPrfx": { - "allOf": [ - { - "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", - "enum": [ - "DOCT", - "MADM", - "MISS", - "MIST", - "MIKS" - ], - "type": "string", - "example": "DOCT" - }, - { - "description": "NamePrefix\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": { + "Id": { "allOf": [ { "title": "Max35Text", @@ -183349,267 +216646,102 @@ "example": 1.234567890123457e+34 }, { - "description": "JobTitle\nTitle of the function.\n" + "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, - "Rspnsblty": { + "LEI": { "allOf": [ { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" }, { - "description": "Responsibility\nRole of a person in an organisation.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, - "Dept": { + "Nm": { "allOf": [ { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 + "maxLength": 140, + "example": 12345 }, { - "description": "Department\nIdentification of a division of a large organisation or building.\n" + "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, - "Othr": { + "PstlAdr": { "allOf": [ { - "title": "OtherContact1", - "description": "Communication device number or electronic address used for communication.\n", + "title": "PostalAddress27", "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { - "ChanlTp": { - "allOf": [ - { - "title": "Max4Text", - "description": "Specifies a character string with a maximum length of 4 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 4, - "example": 1234 - }, - { - "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" - } - ] - }, - "Id": { - "allOf": [ - { - "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", + "AdrTp": { + "title": "AddressType3Choice", "type": "object", - "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", - "properties": { - "Id": { - "allOf": [ - { - "title": "Max34Text", - "description": "Specifies a character string with a maximum length of 34 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 34, - "example": 1.2345678901234568e+33 - }, - { - "description": "Identification\nIdentification assigned by an institution.\n" + "description": "Choice of formats for the type of address.\n", + "anyOf": [ + { + "properties": { + "Cd": { + "allOf": [ + { + "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + { + "description": "Code\nType of address expressed as a code.\n" + } + ] } + }, + "required": [ + "Cd" ] }, - "SchmeNm": { - "allOf": [ - { - "title": "AccountSchemeName1Choice", - "type": "object", - "description": "Sets of elements to identify a name of the identification scheme.\n", - "anyOf": [ + { + "properties": { + "Prtry": { + "allOf": [ { + "title": "GenericIdentification30", + "type": "object", + "description": "Generic scheme identification for a party.\n", "properties": { - "Cd": { + "Id": { "allOf": [ { - "title": "ExternalAccountIdentification1Code", - "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", - "minLength": 1, - "maxLength": 4, + "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { - "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" + "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { + }, + "Issr": { "allOf": [ { "title": "Max35Text", @@ -183620,106 +216752,164 @@ "example": 1.234567890123457e+34 }, { - "description": "Proprietary\nName of the identification scheme, in a free text form.\n" + "description": "Issuer\nEntity that assigns the identification.\n" + } + ] + }, + "SchmeNm": { + "allOf": [ + { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + { + "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ - "Prtry" - ] + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + { + "description": "Proprietary\nType of address expressed as a proprietary code.\n" } - ], - "example": { - "Cd": 1111 - } - }, - { - "description": "SchemeName\nName of the identification scheme.\n" - } - ] - }, - "Issr": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Issuer\nEntity that assigns the identification.\n" + ] } + }, + "required": [ + "Prtry" ] } - }, - "required": [ - "Id" ], "example": { - "Id": 123, - "SchmeNm": { - "Cd": "IBAN" - }, - "Issr": "BIC" + "Cd": "ADDR" } }, - { - "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" - } - ] - } - }, - "required": [ - "Othr" - ] - } - ], - "example": { - "IBAN": "BE71096123456769" - } - }, - { - "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" - } - ] - }, - "Tp": { - "allOf": [ - { - "title": "CashAccountType2Choice", - "description": "Specifies the nature, or use of the account.\n", - "type": "object", - "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", + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, - "maxLength": 4, - "example": 1234 + "maxLength": 140, + "example": 12345 }, - { - "description": "Code\nAccount type, in a coded form.\n" - } - ] - } - }, - "required": [ - "Cd" - ] - }, - { - "properties": { - "Prtry": { - "allOf": [ - { + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "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", @@ -183727,352 +216917,109 @@ "maxLength": 35, "example": 1.234567890123457e+34 }, - { - "description": "Proprietary\nNature or use of the account in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] - } - ], - "example": { - "Cd": "CACC" - } - }, - { - "description": "Type\nSpecifies the nature, or use of the account.\n" - } - ] - }, - "Ccy": { - "allOf": [ - { - "title": "ActiveOrHistoricCurrencyCode", - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTN", - "BWP", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRO", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SPL", - "SRD", - "STD", - "SVC", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TVD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XDR", - "XOF", - "XPF", - "XTS", - "XXX", - "YER", - "ZAR", - "ZMW", - "ZWD" - ] - }, - { - "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" - } - ] - }, - "Nm": { - "allOf": [ - { - "title": "Max70Text", - "description": "Specifies a character string with a maximum length of 70 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 70, - "example": 1.2345678901234567e+99 - }, - { - "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" - } - ] - }, - "Prxy": { - "allOf": [ - { - "title": "ProxyAccountIdentification1", - "description": "Information related to a proxy identification of the account.\n", - "type": "object", - "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" - ] + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US", + "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, - { - "properties": { - "Prtry": { - "allOf": [ - { - "title": "Max35Text", - "description": "Specifies a character string with a maximum length of 35 characters.\n", - "type": "string", - "minLength": 1, - "maxLength": 35, - "example": 1.234567890123457e+34 - }, - { - "description": "Proprietary\nProxy account type, in a proprietary form.\n" - } - ] - } - }, - "required": [ - "Prtry" - ] + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 } - ], + }, "example": { - "Cd": "EMAIL" + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "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": "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" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, - "required": [ - "Id" - ], "example": { - "Tp": { - "Cd": "IBAN" - }, - "Id": 123 + "Id": 123, + "LEI": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number" + } } }, { - "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" + "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, + "required": [ + "FinInstnId" + ], "example": { - "Id": { - "IBAN": "BE71096123456769" - }, - "Tp": { - "Cd": "CACC" + "FinInstnId": { + "BICFI": "J5BMVH7D" }, - "Ccy": "EUR", - "Nm": "My account", - "Prxy": { - "Id": 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" + } } } }, { - "description": "Account\nUnambiguous identification of the account of a party.\n" + "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, - "Agt": { + "Cdtr": { "allOf": [ { - "title": "BranchAndFinancialInstitutionIdentification6", + "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": "FinancialInstitutionIdentification18", + "title": "FinancialInstitutionIdentification23", "type": "object", "description": "Information used to identify a financial institution.\n", "properties": { @@ -184086,7 +217033,7 @@ "example": "J5BMVH7D" }, { - "description": "BICFI \nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" + "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, @@ -184628,16 +217575,16 @@ } }, { - "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" + "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { - "title": "BranchData3", - "type": "object", + "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", "properties": { "Id": { "allOf": [ @@ -184664,7 +217611,7 @@ "example": "529900T8BM49AURSDO55" }, { - "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" + "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, @@ -184686,7 +217633,7 @@ "PstlAdr": { "allOf": [ { - "title": "PostalAddress24", + "title": "PostalAddress27", "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { @@ -184801,6 +217748,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", @@ -184818,12 +217773,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", @@ -184834,12 +217789,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", @@ -184849,6 +217804,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", @@ -184874,28 +217837,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", @@ -184923,12 +217886,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", @@ -184941,30 +217906,26 @@ } }, { - "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" + "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, + "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", - "BldgNb": "Building number", - "PstCd": "Post code", - "TwnNm": "Town name", - "CtrySubDvsn": "Country subdivision", - "Ctry": "Country", - "AdrLine": "Address line" + "BldgNb": "Building number" } } }, { - "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\nIdentifies a specific branch of a financial institution.\n" } ] } @@ -184995,102 +217956,863 @@ } }, { - "description": "Agent\nFinancial institution servicing an account for a party.\n" + "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\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTN", + "BWP", + "BYN", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SPL", + "SRD", + "STD", + "SVC", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TVD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XDR", + "XOF", + "XPF", + "XTS", + "XXX", + "YER", + "ZAR", + "ZMW", + "ZWD" + ] + }, + { + "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.\n" + } + ] + }, + "Nm": { + "allOf": [ + { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + { + "description": "Name\nName of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" + } + ] + }, + "Prxy": { + "allOf": [ + { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "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\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.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", + "type": "string", + "pattern": "^[A-Za-z0-9-_]{43}$", + "maxLength": 48 + }, + { + "description": "SHA-256 signature of the terms\n" + } + ] + } + }, + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + }, + { + "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" } ] } }, "required": [ - "Pty" + "PmtId", + "IntrBkSttlmAmt", + "Dbtr", + "Cdtr", + "UndrlygCstmrCdtTrf", + "VrfctnOfTerms" ], "example": { - "Pty": { - "Id": { - "OrgId": { - "AnyBIC": { - "BICFI": "BICFI" - } - } - }, - "CtryOfRes": "FI" + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" }, - "Acct": { + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + } + }, + "IntrBkSttlmAmt": { + "Amount": 123.45, + "Ccy": "EUR" + }, + "Dbtr": { + "Nm": "Debtor Name" + }, + "DbtrAcct": { "Id": { - "IBAN": "FI2112345600000785" + "IBAN": "IBAN" } }, - "Agt": { + "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": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n" + "description": "CreditTransferTransactionInformation.\nSet of elements providing information specific to the individual credit transfer(s).\n" } ] } }, "required": [ - "OrgnlId", - "Vrfctn" + "GrpHdr", + "CdtTrfTxInf" ], "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" + "GrpHdr": { + "MsgId": 20191113001, + "CreDtTm": "2019-11-13T10:00:00", + "NbOfTxs": 1, + "CtrlSum": 1000, + "InitgPty": { + "Nm": "Initiating Party Name", + "Id": { + "OrgId": { + "Othr": { + "Id": 123456789, + "SchmeNm": { + "Cd": "BBA" + } + } } } + }, + "FwdgAgt": { + "FinInstnId": { + "BICFI": "BBBBBBBB" + } + }, + "DbtrAgt": { + "FinInstnId": { + "BICFI": "AAAAAAAA" + } + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "CCCCCCCC" + } } }, - "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" + "CdtTrfTxInf": { + "PmtId": { + "InstrId": 20191113001, + "EndToEndId": 20191113001 }, - "Id": { - "OrgId": { - "AnyBIC": "ABCDUS33", - "Othr": { - "Id": 123456789, - "Issr": "ABA" - } + "PmtTpInf": { + "InstrPrty": "NORM", + "CtgyPurp": { + "Cd": "SUPP" + } + }, + "InstrForCdtrAgt": { + "Cd": "/ACC/123456789" + }, + "IntrBkSttlmAmt": { + "Amt": 1000, + "Ccy": "EUR" + }, + "ChrgBr": "SHAR", + "CdtrAgt": { + "FinInstnId": { + "BICFI": "CCCCCCCC" + } + }, + "Cdtr": { + "Nm": "Creditor Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "BE71096123456769" } + }, + "RmtInf": { + "Ustrd": "Payment for invoice 12345" } } } - }, - "hexBinary": { - "title": "hexBinary", - "type": "string", - "example": 4660, - "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" } } \ No newline at end of file diff --git a/src/fspiop/v2_0_ISO20022/schemas.ts b/src/fspiop/v2_0_ISO20022/schemas.ts index b7d43c27..1ba28654 100644 --- a/src/fspiop/v2_0_ISO20022/schemas.ts +++ b/src/fspiop/v2_0_ISO20022/schemas.ts @@ -5,170 +5,177 @@ import JsonSchemas from './json-schemas.json' export namespace Schemas { - export const AccountIdentification4Choice = JsonSchemas["AccountIdentification4Choice"] - export const AccountSchemeName1Choice = JsonSchemas["AccountSchemeName1Choice"] - export const ActiveCurrencyAndAmount = JsonSchemas["ActiveCurrencyAndAmount"] - export const ActiveCurrencyAndAmount_SimpleType = JsonSchemas["ActiveCurrencyAndAmount_SimpleType"] - export const ActiveCurrencyCode = JsonSchemas["ActiveCurrencyCode"] - export const ActiveOrHistoricCurrencyAndAmount = JsonSchemas["ActiveOrHistoricCurrencyAndAmount"] - export const ActiveOrHistoricCurrencyAndAmount_SimpleType = JsonSchemas["ActiveOrHistoricCurrencyAndAmount_SimpleType"] - export const ActiveOrHistoricCurrencyCode = JsonSchemas["ActiveOrHistoricCurrencyCode"] - export const AddressType2Code = JsonSchemas["AddressType2Code"] - export const AddressType3Choice = JsonSchemas["AddressType3Choice"] - export const AmountTypeEnum = JsonSchemas["AmountTypeEnum"] - export const AnyBICDec2014Identifier = JsonSchemas["AnyBICDec2014Identifier"] - export const BICFIDec2014Identifier = JsonSchemas["BICFIDec2014Identifier"] - export const BaseOneRate = JsonSchemas["BaseOneRate"] - export const BranchAndFinancialInstitutionIdentification6 = JsonSchemas["BranchAndFinancialInstitutionIdentification6"] - export const BranchAndFinancialInstitutionIdentification8 = JsonSchemas["BranchAndFinancialInstitutionIdentification8"] - export const BranchData3 = JsonSchemas["BranchData3"] - export const BranchData5 = JsonSchemas["BranchData5"] - export const CashAccount40 = JsonSchemas["CashAccount40"] - export const CashAccountType2Choice = JsonSchemas["CashAccountType2Choice"] - export const CategoryPurpose1Choice = JsonSchemas["CategoryPurpose1Choice"] - export const ChargeBearerType1Code = JsonSchemas["ChargeBearerType1Code"] - export const ChargeType3Choice = JsonSchemas["ChargeType3Choice"] - export const Charges16 = JsonSchemas["Charges16"] - export const ClearingChannel2Code = JsonSchemas["ClearingChannel2Code"] - export const ClearingSystemIdentification2Choice = JsonSchemas["ClearingSystemIdentification2Choice"] - export const ClearingSystemMemberIdentification2 = JsonSchemas["ClearingSystemMemberIdentification2"] - export const Contact13 = JsonSchemas["Contact13"] - export const Contact4 = JsonSchemas["Contact4"] - export const CountryCode = JsonSchemas["CountryCode"] - export const CreditTransferTransaction67 = JsonSchemas["CreditTransferTransaction67"] - export const CreditTransferTransaction68 = JsonSchemas["CreditTransferTransaction68"] - export const CreditTransferTransaction68_FX_Quotes = JsonSchemas["CreditTransferTransaction68_FX_Quotes"] - 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"] export const ErrorDescription = JsonSchemas["ErrorDescription"] + export const ExtensionKey = JsonSchemas["ExtensionKey"] + export const ExtensionValue = JsonSchemas["ExtensionValue"] + export const Extension = JsonSchemas["Extension"] + export const ExtensionList = JsonSchemas["ExtensionList"] export const ErrorInformation = JsonSchemas["ErrorInformation"] export const ErrorInformationResponse = JsonSchemas["ErrorInformationResponse"] - export const Exact32HexBinaryText = JsonSchemas["Exact32HexBinaryText"] + export const Max35Text = JsonSchemas["Max35Text"] + export const ISODateTime = JsonSchemas["ISODateTime"] + export const Max140Text = JsonSchemas["Max140Text"] + export const AddressType2Code = JsonSchemas["AddressType2Code"] export const Exact4AlphaNumericText = JsonSchemas["Exact4AlphaNumericText"] - export const Execute_FIToFICustomerCreditTransferV13 = JsonSchemas["Execute_FIToFICustomerCreditTransferV13"] - export const Extension = JsonSchemas["Extension"] - export const ExtensionKey = JsonSchemas["ExtensionKey"] - export const ExtensionList = JsonSchemas["ExtensionList"] - export const ExtensionValue = JsonSchemas["ExtensionValue"] - export const ExternalAccountIdentification1Code = JsonSchemas["ExternalAccountIdentification1Code"] - export const ExternalCashAccountType1Code = JsonSchemas["ExternalCashAccountType1Code"] - export const ExternalCategoryPurpose1Code = JsonSchemas["ExternalCategoryPurpose1Code"] - export const ExternalChargeType1Code = JsonSchemas["ExternalChargeType1Code"] - export const ExternalClearingSystemIdentification1Code = JsonSchemas["ExternalClearingSystemIdentification1Code"] - export const ExternalCreditorAgentInstruction1Code = JsonSchemas["ExternalCreditorAgentInstruction1Code"] - export const ExternalFinancialInstitutionIdentification1Code = JsonSchemas["ExternalFinancialInstitutionIdentification1Code"] - export const ExternalLocalInstrument1Code = JsonSchemas["ExternalLocalInstrument1Code"] + export const GenericIdentification30 = JsonSchemas["GenericIdentification30"] + export const AddressType3Choice = JsonSchemas["AddressType3Choice"] + export const Max70Text = JsonSchemas["Max70Text"] + export const Max16Text = JsonSchemas["Max16Text"] + export const CountryCode = JsonSchemas["CountryCode"] + export const PostalAddress24 = JsonSchemas["PostalAddress24"] + export const AnyBICDec2014Identifier = JsonSchemas["AnyBICDec2014Identifier"] + export const LEIIdentifier = JsonSchemas["LEIIdentifier"] export const ExternalOrganisationIdentification1Code = JsonSchemas["ExternalOrganisationIdentification1Code"] - export const ExternalPaymentTransactionStatus1Code = JsonSchemas["ExternalPaymentTransactionStatus1Code"] + export const OrganisationIdentificationSchemeName1Choice = JsonSchemas["OrganisationIdentificationSchemeName1Choice"] + export const GenericOrganisationIdentification1 = JsonSchemas["GenericOrganisationIdentification1"] + export const OrganisationIdentification29 = JsonSchemas["OrganisationIdentification29"] + export const ISODate = JsonSchemas["ISODate"] + export const DateAndPlaceOfBirth1 = JsonSchemas["DateAndPlaceOfBirth1"] export const ExternalPersonIdentification1Code = JsonSchemas["ExternalPersonIdentification1Code"] - export const ExternalProxyAccountType1Code = JsonSchemas["ExternalProxyAccountType1Code"] - export const ExternalPurpose1Code = JsonSchemas["ExternalPurpose1Code"] - export const ExternalServiceLevel1Code = JsonSchemas["ExternalServiceLevel1Code"] - export const ExternalStatusReason1Code = JsonSchemas["ExternalStatusReason1Code"] - export const ExternalVerificationReason1Code = JsonSchemas["ExternalVerificationReason1Code"] + export const PersonIdentificationSchemeName1Choice = JsonSchemas["PersonIdentificationSchemeName1Choice"] + export const GenericPersonIdentification1 = JsonSchemas["GenericPersonIdentification1"] + export const PersonIdentification13 = JsonSchemas["PersonIdentification13"] + export const Party38Choice = JsonSchemas["Party38Choice"] + export const NamePrefix2Code = JsonSchemas["NamePrefix2Code"] + export const PhoneNumber = JsonSchemas["PhoneNumber"] + export const Max2048Text = JsonSchemas["Max2048Text"] + export const Max4Text = JsonSchemas["Max4Text"] + export const Max128Text = JsonSchemas["Max128Text"] + export const OtherContact1 = JsonSchemas["OtherContact1"] + export const PreferredContactMethod1Code = JsonSchemas["PreferredContactMethod1Code"] + export const Contact4 = JsonSchemas["Contact4"] + export const PartyIdentification135 = JsonSchemas["PartyIdentification135"] + export const BICFIDec2014Identifier = JsonSchemas["BICFIDec2014Identifier"] + export const ExternalClearingSystemIdentification1Code = JsonSchemas["ExternalClearingSystemIdentification1Code"] + export const ClearingSystemIdentification2Choice = JsonSchemas["ClearingSystemIdentification2Choice"] + export const ClearingSystemMemberIdentification2 = JsonSchemas["ClearingSystemMemberIdentification2"] + export const ExternalFinancialInstitutionIdentification1Code = JsonSchemas["ExternalFinancialInstitutionIdentification1Code"] export const FinancialIdentificationSchemeName1Choice = JsonSchemas["FinancialIdentificationSchemeName1Choice"] - export const FinancialInstitutionIdentification18 = JsonSchemas["FinancialInstitutionIdentification18"] - export const FinancialInstitutionIdentification23 = JsonSchemas["FinancialInstitutionIdentification23"] - export const FxRequest_FICreditTransferProposal = JsonSchemas["FxRequest_FICreditTransferProposal"] - export const FxResponse_FICreditTransferConfirmation = JsonSchemas["FxResponse_FICreditTransferConfirmation"] - export const Fxecute_FinancialInstitutionCreditTransferV12 = JsonSchemas["Fxecute_FinancialInstitutionCreditTransferV12"] - export const GenericAccountIdentification1 = JsonSchemas["GenericAccountIdentification1"] export const GenericFinancialIdentification1 = JsonSchemas["GenericFinancialIdentification1"] - export const GenericIdentification3 = JsonSchemas["GenericIdentification3"] - export const GenericIdentification30 = JsonSchemas["GenericIdentification30"] - export const GenericOrganisationIdentification1 = JsonSchemas["GenericOrganisationIdentification1"] - export const GenericOrganisationIdentification3 = JsonSchemas["GenericOrganisationIdentification3"] - export const GenericPersonIdentification1 = JsonSchemas["GenericPersonIdentification1"] - export const GenericPersonIdentification2 = JsonSchemas["GenericPersonIdentification2"] - export const GetPartiesError_IdentificationVerificationReportV03 = JsonSchemas["GetPartiesError_IdentificationVerificationReportV03"] - export const GetParties_IdentificationVerificationReportV03 = JsonSchemas["GetParties_IdentificationVerificationReportV03"] - export const GroupHeader113 = JsonSchemas["GroupHeader113"] - export const GroupHeader120 = JsonSchemas["GroupHeader120"] - export const GroupHeader129 = JsonSchemas["GroupHeader129"] - export const IBAN2007Identifier = JsonSchemas["IBAN2007Identifier"] - export const ISODate = JsonSchemas["ISODate"] - export const ISODateTime = JsonSchemas["ISODateTime"] - export const ISOYear = JsonSchemas["ISOYear"] + export const FinancialInstitutionIdentification18 = JsonSchemas["FinancialInstitutionIdentification18"] + export const BranchData3 = JsonSchemas["BranchData3"] + export const BranchAndFinancialInstitutionIdentification6 = JsonSchemas["BranchAndFinancialInstitutionIdentification6"] + export const Party40Choice = JsonSchemas["Party40Choice"] export const IdentificationAssignment3 = JsonSchemas["IdentificationAssignment3"] - export const IdentificationInformation4 = JsonSchemas["IdentificationInformation4"] export const IdentificationVerificationIndicator = JsonSchemas["IdentificationVerificationIndicator"] - export const Instruction4Code = JsonSchemas["Instruction4Code"] - export const InstructionForCreditorAgent3 = JsonSchemas["InstructionForCreditorAgent3"] - export const InstructionForCreditorAgent3_FX_Quotes = JsonSchemas["InstructionForCreditorAgent3_FX_Quotes"] - export const InstructionForNextAgent1 = JsonSchemas["InstructionForNextAgent1"] - export const LEIIdentifier = JsonSchemas["LEIIdentifier"] - export const LocalInstrument2Choice = JsonSchemas["LocalInstrument2Choice"] - export const Max105Text = JsonSchemas["Max105Text"] - export const Max10Text = JsonSchemas["Max10Text"] - export const Max128Text = JsonSchemas["Max128Text"] - export const Max140Text = JsonSchemas["Max140Text"] - export const Max15NumericText = JsonSchemas["Max15NumericText"] - export const Max16Text = JsonSchemas["Max16Text"] - export const Max2048Text = JsonSchemas["Max2048Text"] - export const Max256Text = JsonSchemas["Max256Text"] + export const ExternalVerificationReason1Code = JsonSchemas["ExternalVerificationReason1Code"] + export const VerificationReason1Choice = JsonSchemas["VerificationReason1Choice"] + export const IBAN2007Identifier = JsonSchemas["IBAN2007Identifier"] export const Max34Text = JsonSchemas["Max34Text"] + export const ExternalAccountIdentification1Code = JsonSchemas["ExternalAccountIdentification1Code"] + export const AccountSchemeName1Choice = JsonSchemas["AccountSchemeName1Choice"] + export const GenericAccountIdentification1 = JsonSchemas["GenericAccountIdentification1"] + export const AccountIdentification4Choice = JsonSchemas["AccountIdentification4Choice"] + export const ExternalCashAccountType1Code = JsonSchemas["ExternalCashAccountType1Code"] + export const CashAccountType2Choice = JsonSchemas["CashAccountType2Choice"] + export const ActiveOrHistoricCurrencyCode = JsonSchemas["ActiveOrHistoricCurrencyCode"] + export const ExternalProxyAccountType1Code = JsonSchemas["ExternalProxyAccountType1Code"] + export const ProxyAccountType1Choice = JsonSchemas["ProxyAccountType1Choice"] + export const ProxyAccountIdentification1 = JsonSchemas["ProxyAccountIdentification1"] + export const CashAccount40 = JsonSchemas["CashAccount40"] + export const IdentificationInformation4 = JsonSchemas["IdentificationInformation4"] + export const VerificationReport4 = JsonSchemas["VerificationReport4"] export const Max350Text = JsonSchemas["Max350Text"] - export const Max35Text = JsonSchemas["Max35Text"] - export const Max4Text = JsonSchemas["Max4Text"] - export const Max70Text = JsonSchemas["Max70Text"] - export const NamePrefix2Code = JsonSchemas["NamePrefix2Code"] - export const Number = JsonSchemas["Number"] - export const OrganisationIdentification29 = JsonSchemas["OrganisationIdentification29"] - export const OrganisationIdentification39 = JsonSchemas["OrganisationIdentification39"] - export const OrganisationIdentificationSchemeName1Choice = JsonSchemas["OrganisationIdentificationSchemeName1Choice"] - export const OtherContact1 = JsonSchemas["OtherContact1"] - export const PacsError_FIToFIPaymentStatusReportV15 = JsonSchemas["PacsError_FIToFIPaymentStatusReportV15"] - export const PacsStatus_FIToFIPaymentStatusReportV15 = JsonSchemas["PacsStatus_FIToFIPaymentStatusReportV15"] - export const Party38Choice = JsonSchemas["Party38Choice"] - export const Party40Choice = JsonSchemas["Party40Choice"] - export const Party52Choice = JsonSchemas["Party52Choice"] - export const PartyIdentification135 = JsonSchemas["PartyIdentification135"] - export const PartyIdentification272 = JsonSchemas["PartyIdentification272"] + export const SupplementaryDataEnvelope1 = JsonSchemas["SupplementaryDataEnvelope1"] + export const SupplementaryData1 = JsonSchemas["SupplementaryData1"] + export const GetParties_IdentificationVerificationReportV03 = JsonSchemas["GetParties_IdentificationVerificationReportV03"] + export const VerificationReport4b = JsonSchemas["VerificationReport4b"] + export const GetPartiesError_IdentificationVerificationReportV03 = JsonSchemas["GetPartiesError_IdentificationVerificationReportV03"] + export const Max15NumericText = JsonSchemas["Max15NumericText"] + export const SettlementMethod1Code = JsonSchemas["SettlementMethod1Code"] + export const SettlementInstruction15 = JsonSchemas["SettlementInstruction15"] + export const GroupHeader129 = JsonSchemas["GroupHeader129"] + export const ULIDIdentifier = JsonSchemas["ULIDIdentifier"] + export const UUIDv4Identifier = JsonSchemas["UUIDv4Identifier"] export const PaymentIdentification13 = JsonSchemas["PaymentIdentification13"] - export const PaymentTransaction163 = JsonSchemas["PaymentTransaction163"] + export const Priority2Code = JsonSchemas["Priority2Code"] + export const ClearingChannel2Code = JsonSchemas["ClearingChannel2Code"] + export const ExternalServiceLevel1Code = JsonSchemas["ExternalServiceLevel1Code"] + export const ServiceLevel8Choice = JsonSchemas["ServiceLevel8Choice"] + export const ExternalLocalInstrument1Code = JsonSchemas["ExternalLocalInstrument1Code"] + export const LocalInstrument2Choice = JsonSchemas["LocalInstrument2Choice"] + export const ExternalCategoryPurpose1Code = JsonSchemas["ExternalCategoryPurpose1Code"] + export const CategoryPurpose1Choice = JsonSchemas["CategoryPurpose1Choice"] export const PaymentTypeInformation28 = JsonSchemas["PaymentTypeInformation28"] - export const PercentageRate = JsonSchemas["PercentageRate"] - export const PersonIdentification13 = JsonSchemas["PersonIdentification13"] - export const PersonIdentification18 = JsonSchemas["PersonIdentification18"] - export const PersonIdentificationSchemeName1Choice = JsonSchemas["PersonIdentificationSchemeName1Choice"] - export const PhoneNumber = JsonSchemas["PhoneNumber"] - export const PostalAddress24 = JsonSchemas["PostalAddress24"] + export const ActiveOrHistoricCurrencyAndAmount_SimpleType = JsonSchemas["ActiveOrHistoricCurrencyAndAmount_SimpleType"] + export const ActiveOrHistoricCurrencyAndAmount = JsonSchemas["ActiveOrHistoricCurrencyAndAmount"] export const PostalAddress27 = JsonSchemas["PostalAddress27"] - export const PreferredContactMethod1Code = JsonSchemas["PreferredContactMethod1Code"] + export const Max256Text = JsonSchemas["Max256Text"] + export const GenericOrganisationIdentification3 = JsonSchemas["GenericOrganisationIdentification3"] + export const OrganisationIdentification39 = JsonSchemas["OrganisationIdentification39"] + export const GenericPersonIdentification2 = JsonSchemas["GenericPersonIdentification2"] + export const PersonIdentification18 = JsonSchemas["PersonIdentification18"] + export const Party52Choice = JsonSchemas["Party52Choice"] export const PreferredContactMethod2Code = JsonSchemas["PreferredContactMethod2Code"] - export const Priority2Code = JsonSchemas["Priority2Code"] - export const ProxyAccountIdentification1 = JsonSchemas["ProxyAccountIdentification1"] - export const ProxyAccountType1Choice = JsonSchemas["ProxyAccountType1Choice"] + export const Contact13 = JsonSchemas["Contact13"] + export const PartyIdentification272 = JsonSchemas["PartyIdentification272"] + export const FinancialInstitutionIdentification23 = JsonSchemas["FinancialInstitutionIdentification23"] + export const BranchData5 = JsonSchemas["BranchData5"] + export const BranchAndFinancialInstitutionIdentification8 = JsonSchemas["BranchAndFinancialInstitutionIdentification8"] + export const UnderlyingCustomerCreditTransfer = JsonSchemas["UnderlyingCustomerCreditTransfer"] + export const ActiveCurrencyAndAmount_SimpleType = JsonSchemas["ActiveCurrencyAndAmount_SimpleType"] + export const ActiveCurrencyCode = JsonSchemas["ActiveCurrencyCode"] + export const ActiveCurrencyAndAmount = JsonSchemas["ActiveCurrencyAndAmount"] + export const BaseOneRate = JsonSchemas["BaseOneRate"] + export const ChargeBearerType1Code = JsonSchemas["ChargeBearerType1Code"] + export const ExternalChargeType1Code = JsonSchemas["ExternalChargeType1Code"] + export const GenericIdentification3 = JsonSchemas["GenericIdentification3"] + export const ChargeType3Choice = JsonSchemas["ChargeType3Choice"] + export const Charges16 = JsonSchemas["Charges16"] + export const ExternalCreditorAgentInstruction1Code = JsonSchemas["ExternalCreditorAgentInstruction1Code"] + export const InstructionForCreditorAgent3 = JsonSchemas["InstructionForCreditorAgent3"] + export const Instruction4Code = JsonSchemas["Instruction4Code"] + export const InstructionForNextAgent1 = JsonSchemas["InstructionForNextAgent1"] + export const ExternalPurpose1Code = JsonSchemas["ExternalPurpose1Code"] export const Purpose2Choice = JsonSchemas["Purpose2Choice"] - export const RegulatoryAuthority2 = JsonSchemas["RegulatoryAuthority2"] - export const RegulatoryReporting3 = JsonSchemas["RegulatoryReporting3"] export const RegulatoryReportingType1Code = JsonSchemas["RegulatoryReportingType1Code"] - export const ServiceLevel8Choice = JsonSchemas["ServiceLevel8Choice"] - export const SettlementInstruction15 = JsonSchemas["SettlementInstruction15"] - export const SettlementMethod1Code = JsonSchemas["SettlementMethod1Code"] - export const StatusReason6Choice = JsonSchemas["StatusReason6Choice"] - export const StatusReasonInformation14 = JsonSchemas["StatusReasonInformation14"] + export const RegulatoryAuthority2 = JsonSchemas["RegulatoryAuthority2"] + export const Max10Text = JsonSchemas["Max10Text"] export const StructuredRegulatoryReporting3 = JsonSchemas["StructuredRegulatoryReporting3"] - export const SupplementaryData1 = JsonSchemas["SupplementaryData1"] - export const SupplementaryDataEnvelope1 = JsonSchemas["SupplementaryDataEnvelope1"] - export const TaxAmount3 = JsonSchemas["TaxAmount3"] - export const TaxAuthorisation1 = JsonSchemas["TaxAuthorisation1"] - export const TaxData1 = JsonSchemas["TaxData1"] + export const RegulatoryReporting3 = JsonSchemas["RegulatoryReporting3"] export const TaxParty1 = JsonSchemas["TaxParty1"] + export const TaxAuthorisation1 = JsonSchemas["TaxAuthorisation1"] export const TaxParty2 = JsonSchemas["TaxParty2"] + export const Number = JsonSchemas["Number"] + export const DatePeriod2 = JsonSchemas["DatePeriod2"] + export const TaxRecordPeriod1Code = JsonSchemas["TaxRecordPeriod1Code"] + export const ISOYear = JsonSchemas["ISOYear"] export const TaxPeriod3 = JsonSchemas["TaxPeriod3"] - export const TaxRecord3 = JsonSchemas["TaxRecord3"] + export const PercentageRate = JsonSchemas["PercentageRate"] export const TaxRecordDetails3 = JsonSchemas["TaxRecordDetails3"] - export const TaxRecordPeriod1Code = JsonSchemas["TaxRecordPeriod1Code"] + export const TaxAmount3 = JsonSchemas["TaxAmount3"] + export const TaxRecord3 = JsonSchemas["TaxRecord3"] + export const TaxData1 = JsonSchemas["TaxData1"] + export const hexBinary = JsonSchemas["hexBinary"] + export const Exact32HexBinaryText = JsonSchemas["Exact32HexBinaryText"] + export const CryptographicLockChoice = JsonSchemas["CryptographicLockChoice"] + export const CreditTransferTransaction67 = JsonSchemas["CreditTransferTransaction67"] export const TermsRequest_FIToFICustomerCreditProposal = JsonSchemas["TermsRequest_FIToFICustomerCreditProposal"] + export const GroupHeader129b = JsonSchemas["GroupHeader129b"] + export const CreditTransferTransaction67b = JsonSchemas["CreditTransferTransaction67b"] export const TermsResponse_FIToFICustomerCreditConfirmation = JsonSchemas["TermsResponse_FIToFICustomerCreditConfirmation"] - export const ULIDIdentifier = JsonSchemas["ULIDIdentifier"] - 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"] + export const GroupHeader120 = JsonSchemas["GroupHeader120"] + export const ExternalPaymentTransactionStatus1Code = JsonSchemas["ExternalPaymentTransactionStatus1Code"] + export const ExternalStatusReason1Code = JsonSchemas["ExternalStatusReason1Code"] + export const StatusReason6Choice = JsonSchemas["StatusReason6Choice"] + export const Max105Text = JsonSchemas["Max105Text"] + export const StatusReasonInformation14b = JsonSchemas["StatusReasonInformation14b"] + export const DateAndDateTime2Choice = JsonSchemas["DateAndDateTime2Choice"] + export const PaymentTransaction163b = JsonSchemas["PaymentTransaction163b"] + export const PacsError_FIToFIPaymentStatusReportV15 = JsonSchemas["PacsError_FIToFIPaymentStatusReportV15"] + export const Execute_FIToFICustomerCreditTransferV13 = JsonSchemas["Execute_FIToFICustomerCreditTransferV13"] + export const StatusReasonInformation14 = JsonSchemas["StatusReasonInformation14"] + export const PaymentTransaction163 = JsonSchemas["PaymentTransaction163"] + export const PacsStatus_FIToFIPaymentStatusReportV15 = JsonSchemas["PacsStatus_FIToFIPaymentStatusReportV15"] + export const PaymentTransaction163patch = JsonSchemas["PaymentTransaction163patch"] + export const PacsStatus_FIToFIPaymentStatusReportV15patch = JsonSchemas["PacsStatus_FIToFIPaymentStatusReportV15patch"] + export const AmountTypeEnum = JsonSchemas["AmountTypeEnum"] + export const InstructionForCreditorAgent3_FX_Quotes = JsonSchemas["InstructionForCreditorAgent3_FX_Quotes"] + export const CreditTransferTransaction68_FX_Quotes = JsonSchemas["CreditTransferTransaction68_FX_Quotes"] + export const FxRequest_FICreditTransferProposal = JsonSchemas["FxRequest_FICreditTransferProposal"] + export const CreditTransferTransaction68_FX_Quotesb = JsonSchemas["CreditTransferTransaction68_FX_Quotesb"] + export const FxResponse_FICreditTransferConfirmation = JsonSchemas["FxResponse_FICreditTransferConfirmation"] + export const CreditTransferTransaction68 = JsonSchemas["CreditTransferTransaction68"] + export const Fxecute_FinancialInstitutionCreditTransferV12 = JsonSchemas["Fxecute_FinancialInstitutionCreditTransferV12"] } diff --git a/src/fspiop/v2_0_ISO20022/types.ts b/src/fspiop/v2_0_ISO20022/types.ts index cea46cc6..d213a52e 100644 --- a/src/fspiop/v2_0_ISO20022/types.ts +++ b/src/fspiop/v2_0_ISO20022/types.ts @@ -5,170 +5,177 @@ import { components } from './openapi' export namespace Types { - export type AccountIdentification4Choice = components['schemas']['AccountIdentification4Choice'] - export type AccountSchemeName1Choice = components['schemas']['AccountSchemeName1Choice'] - export type ActiveCurrencyAndAmount = components['schemas']['ActiveCurrencyAndAmount'] - export type ActiveCurrencyAndAmount_SimpleType = components['schemas']['ActiveCurrencyAndAmount_SimpleType'] - export type ActiveCurrencyCode = components['schemas']['ActiveCurrencyCode'] - export type ActiveOrHistoricCurrencyAndAmount = components['schemas']['ActiveOrHistoricCurrencyAndAmount'] - export type ActiveOrHistoricCurrencyAndAmount_SimpleType = components['schemas']['ActiveOrHistoricCurrencyAndAmount_SimpleType'] - export type ActiveOrHistoricCurrencyCode = components['schemas']['ActiveOrHistoricCurrencyCode'] - export type AddressType2Code = components['schemas']['AddressType2Code'] - export type AddressType3Choice = components['schemas']['AddressType3Choice'] - export type AmountTypeEnum = components['schemas']['AmountTypeEnum'] - export type AnyBICDec2014Identifier = components['schemas']['AnyBICDec2014Identifier'] - export type BICFIDec2014Identifier = components['schemas']['BICFIDec2014Identifier'] - export type BaseOneRate = components['schemas']['BaseOneRate'] - export type BranchAndFinancialInstitutionIdentification6 = components['schemas']['BranchAndFinancialInstitutionIdentification6'] - export type BranchAndFinancialInstitutionIdentification8 = components['schemas']['BranchAndFinancialInstitutionIdentification8'] - export type BranchData3 = components['schemas']['BranchData3'] - export type BranchData5 = components['schemas']['BranchData5'] - export type CashAccount40 = components['schemas']['CashAccount40'] - export type CashAccountType2Choice = components['schemas']['CashAccountType2Choice'] - export type CategoryPurpose1Choice = components['schemas']['CategoryPurpose1Choice'] - export type ChargeBearerType1Code = components['schemas']['ChargeBearerType1Code'] - export type ChargeType3Choice = components['schemas']['ChargeType3Choice'] - export type Charges16 = components['schemas']['Charges16'] - export type ClearingChannel2Code = components['schemas']['ClearingChannel2Code'] - export type ClearingSystemIdentification2Choice = components['schemas']['ClearingSystemIdentification2Choice'] - export type ClearingSystemMemberIdentification2 = components['schemas']['ClearingSystemMemberIdentification2'] - export type Contact13 = components['schemas']['Contact13'] - export type Contact4 = components['schemas']['Contact4'] - export type CountryCode = components['schemas']['CountryCode'] - export type CreditTransferTransaction67 = components['schemas']['CreditTransferTransaction67'] - export type CreditTransferTransaction68 = components['schemas']['CreditTransferTransaction68'] - export type CreditTransferTransaction68_FX_Quotes = components['schemas']['CreditTransferTransaction68_FX_Quotes'] - 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'] export type ErrorDescription = components['schemas']['ErrorDescription'] + export type ExtensionKey = components['schemas']['ExtensionKey'] + export type ExtensionValue = components['schemas']['ExtensionValue'] + export type Extension = components['schemas']['Extension'] + export type ExtensionList = components['schemas']['ExtensionList'] export type ErrorInformation = components['schemas']['ErrorInformation'] export type ErrorInformationResponse = components['schemas']['ErrorInformationResponse'] - export type Exact32HexBinaryText = components['schemas']['Exact32HexBinaryText'] + export type Max35Text = components['schemas']['Max35Text'] + export type ISODateTime = components['schemas']['ISODateTime'] + export type Max140Text = components['schemas']['Max140Text'] + export type AddressType2Code = components['schemas']['AddressType2Code'] export type Exact4AlphaNumericText = components['schemas']['Exact4AlphaNumericText'] - export type Execute_FIToFICustomerCreditTransferV13 = components['schemas']['Execute_FIToFICustomerCreditTransferV13'] - export type Extension = components['schemas']['Extension'] - export type ExtensionKey = components['schemas']['ExtensionKey'] - export type ExtensionList = components['schemas']['ExtensionList'] - export type ExtensionValue = components['schemas']['ExtensionValue'] - export type ExternalAccountIdentification1Code = components['schemas']['ExternalAccountIdentification1Code'] - export type ExternalCashAccountType1Code = components['schemas']['ExternalCashAccountType1Code'] - export type ExternalCategoryPurpose1Code = components['schemas']['ExternalCategoryPurpose1Code'] - export type ExternalChargeType1Code = components['schemas']['ExternalChargeType1Code'] - export type ExternalClearingSystemIdentification1Code = components['schemas']['ExternalClearingSystemIdentification1Code'] - export type ExternalCreditorAgentInstruction1Code = components['schemas']['ExternalCreditorAgentInstruction1Code'] - export type ExternalFinancialInstitutionIdentification1Code = components['schemas']['ExternalFinancialInstitutionIdentification1Code'] - export type ExternalLocalInstrument1Code = components['schemas']['ExternalLocalInstrument1Code'] + export type GenericIdentification30 = components['schemas']['GenericIdentification30'] + export type AddressType3Choice = components['schemas']['AddressType3Choice'] + export type Max70Text = components['schemas']['Max70Text'] + export type Max16Text = components['schemas']['Max16Text'] + export type CountryCode = components['schemas']['CountryCode'] + export type PostalAddress24 = components['schemas']['PostalAddress24'] + export type AnyBICDec2014Identifier = components['schemas']['AnyBICDec2014Identifier'] + export type LEIIdentifier = components['schemas']['LEIIdentifier'] export type ExternalOrganisationIdentification1Code = components['schemas']['ExternalOrganisationIdentification1Code'] - export type ExternalPaymentTransactionStatus1Code = components['schemas']['ExternalPaymentTransactionStatus1Code'] + export type OrganisationIdentificationSchemeName1Choice = components['schemas']['OrganisationIdentificationSchemeName1Choice'] + export type GenericOrganisationIdentification1 = components['schemas']['GenericOrganisationIdentification1'] + export type OrganisationIdentification29 = components['schemas']['OrganisationIdentification29'] + export type ISODate = components['schemas']['ISODate'] + export type DateAndPlaceOfBirth1 = components['schemas']['DateAndPlaceOfBirth1'] export type ExternalPersonIdentification1Code = components['schemas']['ExternalPersonIdentification1Code'] - export type ExternalProxyAccountType1Code = components['schemas']['ExternalProxyAccountType1Code'] - export type ExternalPurpose1Code = components['schemas']['ExternalPurpose1Code'] - export type ExternalServiceLevel1Code = components['schemas']['ExternalServiceLevel1Code'] - export type ExternalStatusReason1Code = components['schemas']['ExternalStatusReason1Code'] - export type ExternalVerificationReason1Code = components['schemas']['ExternalVerificationReason1Code'] + export type PersonIdentificationSchemeName1Choice = components['schemas']['PersonIdentificationSchemeName1Choice'] + export type GenericPersonIdentification1 = components['schemas']['GenericPersonIdentification1'] + export type PersonIdentification13 = components['schemas']['PersonIdentification13'] + export type Party38Choice = components['schemas']['Party38Choice'] + export type NamePrefix2Code = components['schemas']['NamePrefix2Code'] + export type PhoneNumber = components['schemas']['PhoneNumber'] + export type Max2048Text = components['schemas']['Max2048Text'] + export type Max4Text = components['schemas']['Max4Text'] + export type Max128Text = components['schemas']['Max128Text'] + export type OtherContact1 = components['schemas']['OtherContact1'] + export type PreferredContactMethod1Code = components['schemas']['PreferredContactMethod1Code'] + export type Contact4 = components['schemas']['Contact4'] + export type PartyIdentification135 = components['schemas']['PartyIdentification135'] + export type BICFIDec2014Identifier = components['schemas']['BICFIDec2014Identifier'] + export type ExternalClearingSystemIdentification1Code = components['schemas']['ExternalClearingSystemIdentification1Code'] + export type ClearingSystemIdentification2Choice = components['schemas']['ClearingSystemIdentification2Choice'] + export type ClearingSystemMemberIdentification2 = components['schemas']['ClearingSystemMemberIdentification2'] + export type ExternalFinancialInstitutionIdentification1Code = components['schemas']['ExternalFinancialInstitutionIdentification1Code'] export type FinancialIdentificationSchemeName1Choice = components['schemas']['FinancialIdentificationSchemeName1Choice'] - export type FinancialInstitutionIdentification18 = components['schemas']['FinancialInstitutionIdentification18'] - export type FinancialInstitutionIdentification23 = components['schemas']['FinancialInstitutionIdentification23'] - export type FxRequest_FICreditTransferProposal = components['schemas']['FxRequest_FICreditTransferProposal'] - export type FxResponse_FICreditTransferConfirmation = components['schemas']['FxResponse_FICreditTransferConfirmation'] - export type Fxecute_FinancialInstitutionCreditTransferV12 = components['schemas']['Fxecute_FinancialInstitutionCreditTransferV12'] - export type GenericAccountIdentification1 = components['schemas']['GenericAccountIdentification1'] export type GenericFinancialIdentification1 = components['schemas']['GenericFinancialIdentification1'] - export type GenericIdentification3 = components['schemas']['GenericIdentification3'] - export type GenericIdentification30 = components['schemas']['GenericIdentification30'] - export type GenericOrganisationIdentification1 = components['schemas']['GenericOrganisationIdentification1'] - export type GenericOrganisationIdentification3 = components['schemas']['GenericOrganisationIdentification3'] - export type GenericPersonIdentification1 = components['schemas']['GenericPersonIdentification1'] - export type GenericPersonIdentification2 = components['schemas']['GenericPersonIdentification2'] - export type GetPartiesError_IdentificationVerificationReportV03 = components['schemas']['GetPartiesError_IdentificationVerificationReportV03'] - export type GetParties_IdentificationVerificationReportV03 = components['schemas']['GetParties_IdentificationVerificationReportV03'] - export type GroupHeader113 = components['schemas']['GroupHeader113'] - export type GroupHeader120 = components['schemas']['GroupHeader120'] - export type GroupHeader129 = components['schemas']['GroupHeader129'] - export type IBAN2007Identifier = components['schemas']['IBAN2007Identifier'] - export type ISODate = components['schemas']['ISODate'] - export type ISODateTime = components['schemas']['ISODateTime'] - export type ISOYear = components['schemas']['ISOYear'] + export type FinancialInstitutionIdentification18 = components['schemas']['FinancialInstitutionIdentification18'] + export type BranchData3 = components['schemas']['BranchData3'] + export type BranchAndFinancialInstitutionIdentification6 = components['schemas']['BranchAndFinancialInstitutionIdentification6'] + export type Party40Choice = components['schemas']['Party40Choice'] export type IdentificationAssignment3 = components['schemas']['IdentificationAssignment3'] - export type IdentificationInformation4 = components['schemas']['IdentificationInformation4'] export type IdentificationVerificationIndicator = components['schemas']['IdentificationVerificationIndicator'] - export type Instruction4Code = components['schemas']['Instruction4Code'] - export type InstructionForCreditorAgent3 = components['schemas']['InstructionForCreditorAgent3'] - export type InstructionForCreditorAgent3_FX_Quotes = components['schemas']['InstructionForCreditorAgent3_FX_Quotes'] - export type InstructionForNextAgent1 = components['schemas']['InstructionForNextAgent1'] - export type LEIIdentifier = components['schemas']['LEIIdentifier'] - export type LocalInstrument2Choice = components['schemas']['LocalInstrument2Choice'] - export type Max105Text = components['schemas']['Max105Text'] - export type Max10Text = components['schemas']['Max10Text'] - export type Max128Text = components['schemas']['Max128Text'] - export type Max140Text = components['schemas']['Max140Text'] - export type Max15NumericText = components['schemas']['Max15NumericText'] - export type Max16Text = components['schemas']['Max16Text'] - export type Max2048Text = components['schemas']['Max2048Text'] - export type Max256Text = components['schemas']['Max256Text'] + export type ExternalVerificationReason1Code = components['schemas']['ExternalVerificationReason1Code'] + export type VerificationReason1Choice = components['schemas']['VerificationReason1Choice'] + export type IBAN2007Identifier = components['schemas']['IBAN2007Identifier'] export type Max34Text = components['schemas']['Max34Text'] + export type ExternalAccountIdentification1Code = components['schemas']['ExternalAccountIdentification1Code'] + export type AccountSchemeName1Choice = components['schemas']['AccountSchemeName1Choice'] + export type GenericAccountIdentification1 = components['schemas']['GenericAccountIdentification1'] + export type AccountIdentification4Choice = components['schemas']['AccountIdentification4Choice'] + export type ExternalCashAccountType1Code = components['schemas']['ExternalCashAccountType1Code'] + export type CashAccountType2Choice = components['schemas']['CashAccountType2Choice'] + export type ActiveOrHistoricCurrencyCode = components['schemas']['ActiveOrHistoricCurrencyCode'] + export type ExternalProxyAccountType1Code = components['schemas']['ExternalProxyAccountType1Code'] + export type ProxyAccountType1Choice = components['schemas']['ProxyAccountType1Choice'] + export type ProxyAccountIdentification1 = components['schemas']['ProxyAccountIdentification1'] + export type CashAccount40 = components['schemas']['CashAccount40'] + export type IdentificationInformation4 = components['schemas']['IdentificationInformation4'] + export type VerificationReport4 = components['schemas']['VerificationReport4'] export type Max350Text = components['schemas']['Max350Text'] - export type Max35Text = components['schemas']['Max35Text'] - export type Max4Text = components['schemas']['Max4Text'] - export type Max70Text = components['schemas']['Max70Text'] - export type NamePrefix2Code = components['schemas']['NamePrefix2Code'] - export type Number = components['schemas']['Number'] - export type OrganisationIdentification29 = components['schemas']['OrganisationIdentification29'] - export type OrganisationIdentification39 = components['schemas']['OrganisationIdentification39'] - export type OrganisationIdentificationSchemeName1Choice = components['schemas']['OrganisationIdentificationSchemeName1Choice'] - export type OtherContact1 = components['schemas']['OtherContact1'] - export type PacsError_FIToFIPaymentStatusReportV15 = components['schemas']['PacsError_FIToFIPaymentStatusReportV15'] - export type PacsStatus_FIToFIPaymentStatusReportV15 = components['schemas']['PacsStatus_FIToFIPaymentStatusReportV15'] - export type Party38Choice = components['schemas']['Party38Choice'] - export type Party40Choice = components['schemas']['Party40Choice'] - export type Party52Choice = components['schemas']['Party52Choice'] - export type PartyIdentification135 = components['schemas']['PartyIdentification135'] - export type PartyIdentification272 = components['schemas']['PartyIdentification272'] + export type SupplementaryDataEnvelope1 = components['schemas']['SupplementaryDataEnvelope1'] + export type SupplementaryData1 = components['schemas']['SupplementaryData1'] + export type GetParties_IdentificationVerificationReportV03 = components['schemas']['GetParties_IdentificationVerificationReportV03'] + export type VerificationReport4b = components['schemas']['VerificationReport4b'] + export type GetPartiesError_IdentificationVerificationReportV03 = components['schemas']['GetPartiesError_IdentificationVerificationReportV03'] + export type Max15NumericText = components['schemas']['Max15NumericText'] + export type SettlementMethod1Code = components['schemas']['SettlementMethod1Code'] + export type SettlementInstruction15 = components['schemas']['SettlementInstruction15'] + export type GroupHeader129 = components['schemas']['GroupHeader129'] + export type ULIDIdentifier = components['schemas']['ULIDIdentifier'] + export type UUIDv4Identifier = components['schemas']['UUIDv4Identifier'] export type PaymentIdentification13 = components['schemas']['PaymentIdentification13'] - export type PaymentTransaction163 = components['schemas']['PaymentTransaction163'] + export type Priority2Code = components['schemas']['Priority2Code'] + export type ClearingChannel2Code = components['schemas']['ClearingChannel2Code'] + export type ExternalServiceLevel1Code = components['schemas']['ExternalServiceLevel1Code'] + export type ServiceLevel8Choice = components['schemas']['ServiceLevel8Choice'] + export type ExternalLocalInstrument1Code = components['schemas']['ExternalLocalInstrument1Code'] + export type LocalInstrument2Choice = components['schemas']['LocalInstrument2Choice'] + export type ExternalCategoryPurpose1Code = components['schemas']['ExternalCategoryPurpose1Code'] + export type CategoryPurpose1Choice = components['schemas']['CategoryPurpose1Choice'] export type PaymentTypeInformation28 = components['schemas']['PaymentTypeInformation28'] - export type PercentageRate = components['schemas']['PercentageRate'] - export type PersonIdentification13 = components['schemas']['PersonIdentification13'] - export type PersonIdentification18 = components['schemas']['PersonIdentification18'] - export type PersonIdentificationSchemeName1Choice = components['schemas']['PersonIdentificationSchemeName1Choice'] - export type PhoneNumber = components['schemas']['PhoneNumber'] - export type PostalAddress24 = components['schemas']['PostalAddress24'] + export type ActiveOrHistoricCurrencyAndAmount_SimpleType = components['schemas']['ActiveOrHistoricCurrencyAndAmount_SimpleType'] + export type ActiveOrHistoricCurrencyAndAmount = components['schemas']['ActiveOrHistoricCurrencyAndAmount'] export type PostalAddress27 = components['schemas']['PostalAddress27'] - export type PreferredContactMethod1Code = components['schemas']['PreferredContactMethod1Code'] + export type Max256Text = components['schemas']['Max256Text'] + export type GenericOrganisationIdentification3 = components['schemas']['GenericOrganisationIdentification3'] + export type OrganisationIdentification39 = components['schemas']['OrganisationIdentification39'] + export type GenericPersonIdentification2 = components['schemas']['GenericPersonIdentification2'] + export type PersonIdentification18 = components['schemas']['PersonIdentification18'] + export type Party52Choice = components['schemas']['Party52Choice'] export type PreferredContactMethod2Code = components['schemas']['PreferredContactMethod2Code'] - export type Priority2Code = components['schemas']['Priority2Code'] - export type ProxyAccountIdentification1 = components['schemas']['ProxyAccountIdentification1'] - export type ProxyAccountType1Choice = components['schemas']['ProxyAccountType1Choice'] + export type Contact13 = components['schemas']['Contact13'] + export type PartyIdentification272 = components['schemas']['PartyIdentification272'] + export type FinancialInstitutionIdentification23 = components['schemas']['FinancialInstitutionIdentification23'] + export type BranchData5 = components['schemas']['BranchData5'] + export type BranchAndFinancialInstitutionIdentification8 = components['schemas']['BranchAndFinancialInstitutionIdentification8'] + export type UnderlyingCustomerCreditTransfer = components['schemas']['UnderlyingCustomerCreditTransfer'] + export type ActiveCurrencyAndAmount_SimpleType = components['schemas']['ActiveCurrencyAndAmount_SimpleType'] + export type ActiveCurrencyCode = components['schemas']['ActiveCurrencyCode'] + export type ActiveCurrencyAndAmount = components['schemas']['ActiveCurrencyAndAmount'] + export type BaseOneRate = components['schemas']['BaseOneRate'] + export type ChargeBearerType1Code = components['schemas']['ChargeBearerType1Code'] + export type ExternalChargeType1Code = components['schemas']['ExternalChargeType1Code'] + export type GenericIdentification3 = components['schemas']['GenericIdentification3'] + export type ChargeType3Choice = components['schemas']['ChargeType3Choice'] + export type Charges16 = components['schemas']['Charges16'] + export type ExternalCreditorAgentInstruction1Code = components['schemas']['ExternalCreditorAgentInstruction1Code'] + export type InstructionForCreditorAgent3 = components['schemas']['InstructionForCreditorAgent3'] + export type Instruction4Code = components['schemas']['Instruction4Code'] + export type InstructionForNextAgent1 = components['schemas']['InstructionForNextAgent1'] + export type ExternalPurpose1Code = components['schemas']['ExternalPurpose1Code'] export type Purpose2Choice = components['schemas']['Purpose2Choice'] - export type RegulatoryAuthority2 = components['schemas']['RegulatoryAuthority2'] - export type RegulatoryReporting3 = components['schemas']['RegulatoryReporting3'] export type RegulatoryReportingType1Code = components['schemas']['RegulatoryReportingType1Code'] - export type ServiceLevel8Choice = components['schemas']['ServiceLevel8Choice'] - export type SettlementInstruction15 = components['schemas']['SettlementInstruction15'] - export type SettlementMethod1Code = components['schemas']['SettlementMethod1Code'] - export type StatusReason6Choice = components['schemas']['StatusReason6Choice'] - export type StatusReasonInformation14 = components['schemas']['StatusReasonInformation14'] + export type RegulatoryAuthority2 = components['schemas']['RegulatoryAuthority2'] + export type Max10Text = components['schemas']['Max10Text'] export type StructuredRegulatoryReporting3 = components['schemas']['StructuredRegulatoryReporting3'] - export type SupplementaryData1 = components['schemas']['SupplementaryData1'] - export type SupplementaryDataEnvelope1 = components['schemas']['SupplementaryDataEnvelope1'] - export type TaxAmount3 = components['schemas']['TaxAmount3'] - export type TaxAuthorisation1 = components['schemas']['TaxAuthorisation1'] - export type TaxData1 = components['schemas']['TaxData1'] + export type RegulatoryReporting3 = components['schemas']['RegulatoryReporting3'] export type TaxParty1 = components['schemas']['TaxParty1'] + export type TaxAuthorisation1 = components['schemas']['TaxAuthorisation1'] export type TaxParty2 = components['schemas']['TaxParty2'] + export type Number = components['schemas']['Number'] + export type DatePeriod2 = components['schemas']['DatePeriod2'] + export type TaxRecordPeriod1Code = components['schemas']['TaxRecordPeriod1Code'] + export type ISOYear = components['schemas']['ISOYear'] export type TaxPeriod3 = components['schemas']['TaxPeriod3'] - export type TaxRecord3 = components['schemas']['TaxRecord3'] + export type PercentageRate = components['schemas']['PercentageRate'] export type TaxRecordDetails3 = components['schemas']['TaxRecordDetails3'] - export type TaxRecordPeriod1Code = components['schemas']['TaxRecordPeriod1Code'] + export type TaxAmount3 = components['schemas']['TaxAmount3'] + export type TaxRecord3 = components['schemas']['TaxRecord3'] + export type TaxData1 = components['schemas']['TaxData1'] + export type hexBinary = components['schemas']['hexBinary'] + export type Exact32HexBinaryText = components['schemas']['Exact32HexBinaryText'] + export type CryptographicLockChoice = components['schemas']['CryptographicLockChoice'] + export type CreditTransferTransaction67 = components['schemas']['CreditTransferTransaction67'] export type TermsRequest_FIToFICustomerCreditProposal = components['schemas']['TermsRequest_FIToFICustomerCreditProposal'] + export type GroupHeader129b = components['schemas']['GroupHeader129b'] + export type CreditTransferTransaction67b = components['schemas']['CreditTransferTransaction67b'] export type TermsResponse_FIToFICustomerCreditConfirmation = components['schemas']['TermsResponse_FIToFICustomerCreditConfirmation'] - export type ULIDIdentifier = components['schemas']['ULIDIdentifier'] - 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'] + export type GroupHeader120 = components['schemas']['GroupHeader120'] + export type ExternalPaymentTransactionStatus1Code = components['schemas']['ExternalPaymentTransactionStatus1Code'] + export type ExternalStatusReason1Code = components['schemas']['ExternalStatusReason1Code'] + export type StatusReason6Choice = components['schemas']['StatusReason6Choice'] + export type Max105Text = components['schemas']['Max105Text'] + export type StatusReasonInformation14b = components['schemas']['StatusReasonInformation14b'] + export type DateAndDateTime2Choice = components['schemas']['DateAndDateTime2Choice'] + export type PaymentTransaction163b = components['schemas']['PaymentTransaction163b'] + export type PacsError_FIToFIPaymentStatusReportV15 = components['schemas']['PacsError_FIToFIPaymentStatusReportV15'] + export type Execute_FIToFICustomerCreditTransferV13 = components['schemas']['Execute_FIToFICustomerCreditTransferV13'] + export type StatusReasonInformation14 = components['schemas']['StatusReasonInformation14'] + export type PaymentTransaction163 = components['schemas']['PaymentTransaction163'] + export type PacsStatus_FIToFIPaymentStatusReportV15 = components['schemas']['PacsStatus_FIToFIPaymentStatusReportV15'] + export type PaymentTransaction163patch = components['schemas']['PaymentTransaction163patch'] + export type PacsStatus_FIToFIPaymentStatusReportV15patch = components['schemas']['PacsStatus_FIToFIPaymentStatusReportV15patch'] + export type AmountTypeEnum = components['schemas']['AmountTypeEnum'] + export type InstructionForCreditorAgent3_FX_Quotes = components['schemas']['InstructionForCreditorAgent3_FX_Quotes'] + export type CreditTransferTransaction68_FX_Quotes = components['schemas']['CreditTransferTransaction68_FX_Quotes'] + export type FxRequest_FICreditTransferProposal = components['schemas']['FxRequest_FICreditTransferProposal'] + export type CreditTransferTransaction68_FX_Quotesb = components['schemas']['CreditTransferTransaction68_FX_Quotesb'] + export type FxResponse_FICreditTransferConfirmation = components['schemas']['FxResponse_FICreditTransferConfirmation'] + export type CreditTransferTransaction68 = components['schemas']['CreditTransferTransaction68'] + export type Fxecute_FinancialInstitutionCreditTransferV12 = components['schemas']['Fxecute_FinancialInstitutionCreditTransferV12'] }