pain

A Rust library to manage ISO 20022 pain.001 payment initiation messages widely used for corporate to bank payments.

Welcome to pain 👋

Website • Documentation • Report Bug • Request Feature • Contributing Guidelines

Overview 📖

Payment Initiation (PI) is a library that provides a set of structs and enums that can be used to serialize and deserialize SEPA payment information using the serde library.

The structs include Payment, OriginalGroupInfoAndStatus, PaymentInfo, PaymentTypeInfo, ServiceLevel, Debtor, PostalAddress, DebtorAccount, AccountId, DebtorAgent, FinancialInstitutionId, CreditTransferTransactionInfo, PaymentId, Amount, InstructedAmount, Creditor, CreditorAccount, RemittanceInfo, and CreditorAgent.

The enum is PaymentFormat and has four variants: Pain001_001_02, Pain001_001_03, Pain001_001_04, and Pain001_001_05.

Features ✨

Coming soon...

Installation 📦

It takes just a few minutes to get up and running with pain.

Requirements

pain requires Rust 1.67.0 or later.

Documentation

ℹ️ Info: Please check out our website for more information and find our documentation on docs.rs, lib.rs and crates.io.

Usage 📖

To use pain in your project, add the following to your Cargo.toml file:

[dependencies]
pain = "0.0.1"

Add the following to your main.rs file:

extern crate pain;
use pain::*;

then you can use the functions in your application code.

Examples

PAIN comes with a set of examples that you can use to get started. The examples are located in the examples directory of the project. To run the examples, clone the repository and run the following command in your terminal from the project root directory.

cargo run --example pain

Semantic Versioning Policy 🚥

For transparency into our release cycle and in striving to maintain backward compatibility, PAIN follows semantic versioning.

License 📝

The project is licensed under the terms of both the MIT license and the Apache License (Version 2.0).

• Apache License, Version 2.0
• MIT license

Contribution 🤝

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Acknowledgements 💙

A big thank you to all the awesome contributors of Mini Functions for their help and support. A special thank you goes to the Rust Reddit community for providing a lot of useful suggestions on how to improve this project.