miso20022 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [2025] [BAAS Corporation d/b/a Mbanq]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,341 @@
1
+ Metadata-Version: 2.4
2
+ Name: miso20022
3
+ Version: 0.1.0
4
+ Summary: ISO 20022 Message Generator for US Payment Rails
5
+ Author-email: Mbanq <developers@mbanq.com>, Sai Vatsavai <sai.vatsavai@mbanq.com>, Vamsi Krishna <vamsi.krishna@mbanq.com>
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/Mbanq/iso20022
8
+ Project-URL: Bug Tracker, https://github.com/Mbanq/iso20022/issues
9
+ Keywords: iso20022,financial,messaging,banking,fedwire,us payment rails,fednow
10
+ Classifier: Development Status :: 2 - Pre-Alpha
11
+ Classifier: Intended Audience :: Financial and Insurance Industry
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Programming Language :: Python :: 3.7
14
+ Classifier: Programming Language :: Python :: 3.8
15
+ Classifier: Programming Language :: Python :: 3.9
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Topic :: Office/Business :: Financial
18
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
19
+ Requires-Python: >=3.7
20
+ Description-Content-Type: text/markdown
21
+ License-File: LICENSE
22
+ Requires-Dist: xmlschema>=1.9.0
23
+ Requires-Dist: python-dotenv>=0.19.0
24
+ Requires-Dist: xmltodict>=0.13.0
25
+ Requires-Dist: lxml>=4.9.0
26
+ Requires-Dist: setuptools~=58.0.4
27
+ Dynamic: license-file
28
+
29
+ # MISO20022 Python Library
30
+
31
+ This package provides a set of tools for generating and working with ISO 20022 financial messages, with a focus on the US Payment Rails.
32
+
33
+
34
+ ## Installation
35
+
36
+ You can install the package from PyPI:
37
+
38
+ ```bash
39
+ pip install miso20022
40
+ ```
41
+
42
+ ## Usage Examples
43
+
44
+ This section provides detailed examples for the core functionalities of the library.
45
+
46
+ **Index:**
47
+ - [Generating a `pacs.008.001.08` (Customer Credit Transfer) Message](#generating-a-pacs00800108-customer-credit-transfer-message)
48
+ - [Generating a `pacs.028.001.03` (Payment Status Request) Message](#generating-a-pacs02800103-payment-status-request-message)
49
+ - [Parsing a `pacs.008.001.08` XML to JSON](#parsing-a-pacs00800108-xml-to-json)
50
+ - [Parsing a `pacs.002.001.10` (Payment Status Report) XML to JSON](#parsing-a-pacs00200110-payment-status-report-xml-to-json)
51
+
52
+ ---
53
+
54
+ ### Input JSON Structure
55
+
56
+ The `generate_fedwire_message` function expects a specific JSON structure for the `payload` argument. Below are the expected formats for the supported message types.
57
+
58
+ #### `pacs.008.001.08` (Customer Credit Transfer)
59
+
60
+ The payload for a `pacs.008` message should follow this structure:
61
+
62
+ ```json
63
+ {
64
+ "fedWireMessage": {
65
+ "inputMessageAccountabilityData": {
66
+ "inputCycleDate": "20250109",
67
+ "inputSource": "MBANQ",
68
+ "inputSequenceNumber": "001000001"
69
+ },
70
+ "amount": {
71
+ "amount": "1000"
72
+ },
73
+ "senderDepositoryInstitution": {
74
+ "senderABANumber": "<routing_number>",
75
+ "senderShortName": "Pypi Bank"
76
+ },
77
+ "receiverDepositoryInstitution": {
78
+ "receiverABANumber": "<routing_number>",
79
+ "receiverShortName": "HelloBank"
80
+ },
81
+ "originator": {
82
+ "personal": {
83
+ "name": "JANE SMITH",
84
+ "address": {
85
+ "addressLineOne": "456 eat street",
86
+ "addressLineTwo": "SOMEWHERE, CA 67890",
87
+ "addressLineThree": ""
88
+ },
89
+ "identifier": "<account_number>"
90
+ }
91
+ },
92
+ "beneficiary": {
93
+ "personal": {
94
+ "name": "JOHN DOE",
95
+ "address": {
96
+ "addressLineOne": "123 Main street",
97
+ "addressLineTwo": "ANYTOWN, TX 12345",
98
+ "addressLineThree": ""
99
+ },
100
+ "identifier": "<account_number>"
101
+ }
102
+ }
103
+ }
104
+ }
105
+ ```
106
+
107
+ #### `pacs.028.001.03` (Payment Status Request)
108
+
109
+ The payload for a `pacs.028` message should follow this structure:
110
+
111
+ ```json
112
+ {
113
+ "fedWireMessage": {
114
+ "inputMessageAccountabilityData": {
115
+ "inputCycleDate": "20250109",
116
+ "inputSource": "MBANQ",
117
+ "inputSequenceNumber": "001000002"
118
+ },
119
+ "senderDepositoryInstitution": {
120
+ "senderABANumber": "<routing_number>",
121
+ "senderShortName": "<short_name>"
122
+ },
123
+ "receiverDepositoryInstitution": {
124
+ "receiverABANumber": "<routing_number>",
125
+ "receiverShortName": "<short_name>"
126
+ }
127
+ },
128
+ "message_id": "PACS028REQ20250109001",
129
+ "original_msg_id": "20250109MBANQ001000001",
130
+ "original_msg_nm_id": "pacs.008.001.08",
131
+ "original_creation_datetime": "2025-01-09T12:34:56Z",
132
+ "original_end_to_end_id": "MEtoEIDCJShqZKb"
133
+ }
134
+ ```
135
+
136
+ ### Generating a `pacs.008.001.08` (Customer Credit Transfer) Message
137
+
138
+ This example shows how to generate a Fedwire `pacs.008` message from a JSON payload.
139
+
140
+ ```python
141
+ import json
142
+ from miso20022.fedwire import generate_fedwire_message
143
+
144
+ # 1. Load your payment data from a JSON object
145
+ with open('sample_files/sample_payload.json', 'r') as f:
146
+ payload = json.load(f)
147
+
148
+ # 2. Define the necessary message parameters
149
+ message_code = 'urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08'
150
+ environment = "TEST" # Or "PROD"
151
+ fed_aba = '000000008' # The ABA number for the Fed
152
+ xsd_path = 'proprietary_fed_file.xsd' # The XSD file for fedwire format
153
+
154
+ # 3. Generate the complete XML message
155
+ _, _, complete_message = generate_fedwire_message(
156
+ message_code=message_code,
157
+ environment=environment,
158
+ fed_aba=fed_aba,
159
+ payload=payload,
160
+ xsd_path=xsd_path
161
+ )
162
+
163
+ # 4. Save the message to a file
164
+ if complete_message:
165
+ with open('generated_pacs.008.xml', 'w') as f:
166
+ f.write(complete_message)
167
+
168
+ print("pacs.008.001.08 message generated successfully!")
169
+ ```
170
+
171
+ ### Generating a `pacs.028.001.03` (Payment Status Request) Message
172
+
173
+ This example shows how to generate a `pacs.028` payment status request.
174
+
175
+ ```python
176
+ import json
177
+ from miso20022.fedwire import generate_fedwire_message
178
+
179
+ # 1. Load the payload for the status request
180
+ with open('sample_files/sample_pacs028_payload.json', 'r') as f:
181
+ payload = json.load(f)
182
+
183
+ # 2. Define message parameters
184
+ message_code = 'urn:iso:std:iso:20022:tech:xsd:pacs.028.001.03'
185
+ environment = "TEST" # Or "PROD"
186
+ fed_aba = '000000008'
187
+ xsd_path = 'proprietary_fed_file.xsd'
188
+
189
+ # 3. Generate the XML message
190
+ _, _, complete_message = generate_fedwire_message(
191
+ message_code=message_code,
192
+ environment=environment,
193
+ fed_aba=fed_aba,
194
+ payload=payload,
195
+ xsd_path=xsd_path
196
+ )
197
+
198
+ # 4. Save the message to a file
199
+ if complete_message:
200
+ with open('generated_pacs.028.xml', 'w') as f:
201
+ f.write(complete_message)
202
+
203
+ print("pacs.028.001.03 message generated successfully!")
204
+ ```
205
+
206
+ ### Parsing a `pacs.008.001.08` XML to JSON
207
+
208
+ This example shows how to parse a `pacs.008` XML file and convert it into a simplified JSON object.
209
+
210
+ ```python
211
+ from miso20022.fedwire import generate_fedwire_payload
212
+ import json
213
+
214
+ # 1. Define the path to your XML file and the message code
215
+ xml_file = 'incoming_pacs.008.xml'
216
+ message_code = 'urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08'
217
+
218
+ # 2. Parse the XML file
219
+ fedwire_json = generate_fedwire_payload(xml_file, message_code)
220
+
221
+ # 3. Save the JSON payload to a file
222
+ if fedwire_json:
223
+ with open('parsed_pacs.008.json', 'w') as f:
224
+ json.dump(fedwire_json, f, indent=4)
225
+
226
+ print("pacs.008.001.08 XML parsed to JSON successfully!")
227
+ ```
228
+
229
+ ### Parsing a `pacs.002.001.10` (Payment Status Report) XML to JSON
230
+
231
+ This example shows how to parse a `pacs.002` payment status report (ack/nack) into a JSON object.
232
+
233
+ ```python
234
+ from miso20022.fedwire import generate_fedwire_payload
235
+ import json
236
+
237
+ # 1. Define the path to your XML file and the message code
238
+ xml_file = 'sample_files/pacs.002_PaymentAck.xml'
239
+ message_code = 'urn:iso:std:iso:20022:tech:xsd:pacs.002.001.10'
240
+
241
+ # 2. Parse the XML to get the JSON payload
242
+ fedwire_json = generate_fedwire_payload(xml_file, message_code)
243
+
244
+ # 3. Save the payload to a JSON file
245
+ if fedwire_json:
246
+ with open('parsed_pacs.002_payload.json', 'w') as f:
247
+ json.dump(fedwire_json, f, indent=4)
248
+
249
+ print("pacs.002.001.10 XML parsed to JSON successfully!")
250
+ ```
251
+
252
+ ## Command-Line Interface (CLI)
253
+
254
+ The package includes a command-line tool, `miso20022`, for generating and parsing messages directly from your terminal.
255
+
256
+ ### Generating a Message
257
+
258
+ **Usage:**
259
+
260
+ ```bash
261
+ miso20022 generate --message_code [MESSAGE_CODE] --environment [ENV] --fed-aba [ABA_NUMBER] --input-file [PAYLOAD_FILE] --output-file [OUTPUT_XML]
262
+ ```
263
+
264
+ **Arguments:**
265
+
266
+ - `--message_code`: The ISO 20022 message code (e.g., `urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08`).
267
+ - `--environment`: The environment for the message (`TEST` or `PROD`).
268
+ - `--fed-aba`: The Fedwire ABA number.
269
+ - `--input-file`: Path to the input JSON payload file.
270
+ - `--output-file`: (Optional) Path to save the generated XML message.
271
+ - `--xsd-file`: (Optional) Path to the XSD file for validation.
272
+
273
+ **Example:**
274
+
275
+ ```bash
276
+ miso20022 generate \
277
+ --message_code urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08 \
278
+ --environment TEST \
279
+ --fed-aba 000000008 \
280
+ --input-file sample_files/sample_payment.json \
281
+ --output-file pacs.008_output.xml
282
+ ```
283
+
284
+ ### Parsing a Message
285
+
286
+ **Usage:**
287
+
288
+ ```bash
289
+ miso20022 parse --input-file [INPUT_XML] --message-code [MESSAGE_CODE] --output-file [OUTPUT_JSON]
290
+ ```
291
+
292
+ **Arguments:**
293
+
294
+ - `--input-file`: Path to the input ISO 20022 XML file.
295
+ - `--message-code`: The ISO 20022 message code of the input file.
296
+ - `--output-file`: (Optional) Path to save the output JSON payload.
297
+
298
+ **Example:**
299
+
300
+ ```bash
301
+ miso20022 parse \
302
+ --input-file sample_files/pacs.008.001.008_2025_1.xml \
303
+ --message-code urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08 \
304
+ --output-file parsed_payload.json
305
+ ```
306
+
307
+ ---
308
+
309
+ ## Supported Message Types
310
+
311
+ The library provides different levels of support for various message types.
312
+
313
+ ### Message Generation (`generate_fedwire_message`)
314
+
315
+ The following message types are fully supported with dedicated data models for generating complete XML messages:
316
+
317
+ - **`pacs.008.001.08`**: FI to FI Customer Credit Transfer
318
+ - **`pacs.028.001.03`**: FI to FI Payment Status Request
319
+
320
+ While other message types might be generated using the generic handlers, these are the ones with first-class support.
321
+
322
+ ### XML to JSON Parsing (`generate_fedwire_payload`)
323
+
324
+ The library can parse the following XML message types into a simplified Fedwire JSON format:
325
+
326
+ - **`pacs.008.001.08`**: FI to FI Customer Credit Transfer
327
+ - **`pacs.002.001.10`**: FI to FI Payment Status Report
328
+
329
+ Support for parsing other message types can be added by creating new mapping functions.
330
+
331
+ ### Future Support
332
+
333
+ We are actively working to expand the range of supported message types. Future releases will include built-in support for additional `pacs`, `camt`, and other ISO 20022 messages, with planned support for FedNow services. Stay tuned for updates!
334
+
335
+ ## Contributing
336
+
337
+ Contributions are welcome! Please refer to the [Project repository](https://github.com/Mbanq/iso20022) for contribution guidelines, to open an issue, or to submit a pull request.
338
+
339
+ <p align="center"><strong style="font-size: 2em">Built with ❤️ in the Beautiful State of Washington!</strong></p>
340
+
341
+