miso20022 0.1.0__tar.gz

miso20022-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2025] [BAAS Corporation d/b/a Mbanq]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

miso20022-0.1.0/PKG-INFO

@@ -0,0 +1,341 @@
+Metadata-Version: 2.4
+Name: miso20022
+Version: 0.1.0
+Summary: ISO 20022 Message Generator for US Payment Rails
+Author-email: Mbanq <developers@mbanq.com>, Sai Vatsavai <sai.vatsavai@mbanq.com>, Vamsi Krishna <vamsi.krishna@mbanq.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Mbanq/iso20022
+Project-URL: Bug Tracker, https://github.com/Mbanq/iso20022/issues
+Keywords: iso20022,financial,messaging,banking,fedwire,us payment rails,fednow
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xmlschema>=1.9.0
+Requires-Dist: python-dotenv>=0.19.0
+Requires-Dist: xmltodict>=0.13.0
+Requires-Dist: lxml>=4.9.0
+Requires-Dist: setuptools~=58.0.4
+Dynamic: license-file
+
+# MISO20022 Python Library
+
+This package provides a set of tools for generating and working with ISO 20022 financial messages, with a focus on the US Payment Rails.
+
+
+## Installation
+
+You can install the package from PyPI:
+
+```bash
+pip install miso20022
+```
+
+## Usage Examples
+
+This section provides detailed examples for the core functionalities of the library.
+
+**Index:**
+- [Generating a `pacs.008.001.08` (Customer Credit Transfer) Message](#generating-a-pacs00800108-customer-credit-transfer-message)
+- [Generating a `pacs.028.001.03` (Payment Status Request) Message](#generating-a-pacs02800103-payment-status-request-message)
+- [Parsing a `pacs.008.001.08` XML to JSON](#parsing-a-pacs00800108-xml-to-json)
+- [Parsing a `pacs.002.001.10` (Payment Status Report) XML to JSON](#parsing-a-pacs00200110-payment-status-report-xml-to-json)
+
+---
+
+### Input JSON Structure
+
+The `generate_fedwire_message` function expects a specific JSON structure for the `payload` argument. Below are the expected formats for the supported message types.
+
+#### `pacs.008.001.08` (Customer Credit Transfer)
+
+The payload for a `pacs.008` message should follow this structure:
+
+```json
+{
+  "fedWireMessage": {
+    "inputMessageAccountabilityData": {
+      "inputCycleDate": "20250109",
+      "inputSource": "MBANQ",
+      "inputSequenceNumber": "001000001"
+    },
+    "amount": {
+      "amount": "1000"
+    },
+    "senderDepositoryInstitution": {
+      "senderABANumber": "<routing_number>",
+      "senderShortName": "Pypi Bank"
+    },
+    "receiverDepositoryInstitution": {
+      "receiverABANumber": "<routing_number>",
+      "receiverShortName": "HelloBank"
+    },
+    "originator": {
+      "personal": {
+        "name": "JANE SMITH",
+        "address": {
+          "addressLineOne": "456 eat street",
+          "addressLineTwo": "SOMEWHERE, CA 67890",
+          "addressLineThree": ""
+        },
+        "identifier": "<account_number>"
+      }
+    },
+    "beneficiary": {
+      "personal": {
+        "name": "JOHN DOE",
+        "address": {
+          "addressLineOne": "123 Main street",
+          "addressLineTwo": "ANYTOWN, TX 12345",
+          "addressLineThree": ""
+        },
+        "identifier": "<account_number>"
+      }
+    }
+  }
+}
+```
+
+#### `pacs.028.001.03` (Payment Status Request)
+
+The payload for a `pacs.028` message should follow this structure:
+
+```json
+{
+  "fedWireMessage": {
+    "inputMessageAccountabilityData": {
+      "inputCycleDate": "20250109",
+      "inputSource": "MBANQ",
+      "inputSequenceNumber": "001000002"
+    },
+    "senderDepositoryInstitution": {
+      "senderABANumber": "<routing_number>",
+      "senderShortName": "<short_name>"
+    },
+    "receiverDepositoryInstitution": {
+      "receiverABANumber": "<routing_number>",
+      "receiverShortName": "<short_name>"
+    }
+  },
+  "message_id": "PACS028REQ20250109001",
+  "original_msg_id": "20250109MBANQ001000001",
+  "original_msg_nm_id": "pacs.008.001.08",
+  "original_creation_datetime": "2025-01-09T12:34:56Z",
+  "original_end_to_end_id": "MEtoEIDCJShqZKb"
+}
+```
+
+### Generating a `pacs.008.001.08` (Customer Credit Transfer) Message
+
+This example shows how to generate a Fedwire `pacs.008` message from a JSON payload.
+
+```python
+import json
+from miso20022.fedwire import generate_fedwire_message
+
+# 1. Load your payment data from a JSON object
+with open('sample_files/sample_payload.json', 'r') as f:
+    payload = json.load(f)
+
+# 2. Define the necessary message parameters
+message_code = 'urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08'
+environment = "TEST"  # Or "PROD"
+fed_aba = '000000008' # The ABA number for the Fed
+xsd_path = 'proprietary_fed_file.xsd' # The XSD file for fedwire format
+
+# 3. Generate the complete XML message
+_, _, complete_message = generate_fedwire_message(
+    message_code=message_code,
+    environment=environment,
+    fed_aba=fed_aba,
+    payload=payload,
+    xsd_path=xsd_path
+)
+
+# 4. Save the message to a file
+if complete_message:
+    with open('generated_pacs.008.xml', 'w') as f:
+        f.write(complete_message)
+
+print("pacs.008.001.08 message generated successfully!")
+```
+
+### Generating a `pacs.028.001.03` (Payment Status Request) Message
+
+This example shows how to generate a `pacs.028` payment status request.
+
+```python
+import json
+from miso20022.fedwire import generate_fedwire_message
+
+# 1. Load the payload for the status request
+with open('sample_files/sample_pacs028_payload.json', 'r') as f:
+    payload = json.load(f)
+
+# 2. Define message parameters
+message_code = 'urn:iso:std:iso:20022:tech:xsd:pacs.028.001.03'
+environment = "TEST"  # Or "PROD"
+fed_aba = '000000008'
+xsd_path = 'proprietary_fed_file.xsd'
+
+# 3. Generate the XML message
+_, _, complete_message = generate_fedwire_message(
+    message_code=message_code,
+    environment=environment,
+    fed_aba=fed_aba,
+    payload=payload,
+    xsd_path=xsd_path
+)
+
+# 4. Save the message to a file
+if complete_message:
+    with open('generated_pacs.028.xml', 'w') as f:
+        f.write(complete_message)
+
+print("pacs.028.001.03 message generated successfully!")
+```
+
+### Parsing a `pacs.008.001.08` XML to JSON
+
+This example shows how to parse a `pacs.008` XML file and convert it into a simplified JSON object.
+
+```python
+from miso20022.fedwire import generate_fedwire_payload
+import json
+
+# 1. Define the path to your XML file and the message code
+xml_file = 'incoming_pacs.008.xml'
+message_code = 'urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08'
+
+# 2. Parse the XML file
+fedwire_json = generate_fedwire_payload(xml_file, message_code)
+
+# 3. Save the JSON payload to a file
+if fedwire_json:
+    with open('parsed_pacs.008.json', 'w') as f:
+        json.dump(fedwire_json, f, indent=4)
+
+print("pacs.008.001.08 XML parsed to JSON successfully!")
+```
+
+### Parsing a `pacs.002.001.10` (Payment Status Report) XML to JSON
+
+This example shows how to parse a `pacs.002` payment status report (ack/nack) into a JSON object.
+
+```python
+from miso20022.fedwire import generate_fedwire_payload
+import json
+
+# 1. Define the path to your XML file and the message code
+xml_file = 'sample_files/pacs.002_PaymentAck.xml'
+message_code = 'urn:iso:std:iso:20022:tech:xsd:pacs.002.001.10'
+
+# 2. Parse the XML to get the JSON payload
+fedwire_json = generate_fedwire_payload(xml_file, message_code)
+
+# 3. Save the payload to a JSON file
+if fedwire_json:
+    with open('parsed_pacs.002_payload.json', 'w') as f:
+        json.dump(fedwire_json, f, indent=4)
+
+print("pacs.002.001.10 XML parsed to JSON successfully!")
+```
+
+## Command-Line Interface (CLI)
+
+The package includes a command-line tool, `miso20022`, for generating and parsing messages directly from your terminal.
+
+### Generating a Message
+
+**Usage:**
+
+```bash
+miso20022 generate --message_code [MESSAGE_CODE] --environment [ENV] --fed-aba [ABA_NUMBER] --input-file [PAYLOAD_FILE] --output-file [OUTPUT_XML]
+```
+
+**Arguments:**
+
+-   `--message_code`: The ISO 20022 message code (e.g., `urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08`).
+-   `--environment`: The environment for the message (`TEST` or `PROD`).
+-   `--fed-aba`: The Fedwire ABA number.
+-   `--input-file`: Path to the input JSON payload file.
+-   `--output-file`: (Optional) Path to save the generated XML message.
+-   `--xsd-file`: (Optional) Path to the XSD file for validation.
+
+**Example:**
+
+```bash
+miso20022 generate \
+    --message_code urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08 \
+    --environment TEST \
+    --fed-aba 000000008 \
+    --input-file sample_files/sample_payment.json \
+    --output-file pacs.008_output.xml
+```
+
+### Parsing a Message
+
+**Usage:**
+
+```bash
+miso20022 parse --input-file [INPUT_XML] --message-code [MESSAGE_CODE] --output-file [OUTPUT_JSON]
+```
+
+**Arguments:**
+
+-   `--input-file`: Path to the input ISO 20022 XML file.
+-   `--message-code`: The ISO 20022 message code of the input file.
+-   `--output-file`: (Optional) Path to save the output JSON payload.
+
+**Example:**
+
+```bash
+miso20022 parse \
+    --input-file sample_files/pacs.008.001.008_2025_1.xml \
+    --message-code urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08 \
+    --output-file parsed_payload.json
+```
+
+---
+
+## Supported Message Types
+
+The library provides different levels of support for various message types.
+
+### Message Generation (`generate_fedwire_message`)
+
+The following message types are fully supported with dedicated data models for generating complete XML messages:
+
+-   **`pacs.008.001.08`**: FI to FI Customer Credit Transfer
+-   **`pacs.028.001.03`**: FI to FI Payment Status Request
+
+While other message types might be generated using the generic handlers, these are the ones with first-class support.
+
+### XML to JSON Parsing (`generate_fedwire_payload`)
+
+The library can parse the following XML message types into a simplified Fedwire JSON format:
+
+-   **`pacs.008.001.08`**: FI to FI Customer Credit Transfer
+-   **`pacs.002.001.10`**: FI to FI Payment Status Report
+
+Support for parsing other message types can be added by creating new mapping functions.
+
+### Future Support
+
+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!
+
+## Contributing
+
+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.
+
+<p align="center"><strong style="font-size: 2em">Built with ❤️ in the Beautiful State of Washington!</strong></p>
+
+