ethqr-gen 0.1.0

Ethiopian QR Code Payment Generator - EMVCo compliant QR codes for IPS ET
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

# ethqr-gen

[![CI](https://github.com/dagregi/ethqr-gen/workflows/CI/badge.svg)](https://github.com/dagregi/ethqr-gen/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/ethqr-gen.svg)](https://crates.io/crates/ethqr-gen)
[![Documentation](https://docs.rs/ethqr-gen/badge.svg)](https://docs.rs/ethqr-gen)
[![Downloads](https://img.shields.io/crates/d/ethqr-gen.svg)](https://crates.io/crates/ethqr-gen)
[![License: MIT OR Apache-2.0](https://img.shields.io/crates/l/ethqr-gen.svg)](#license)
[![Rust Version](https://img.shields.io/badge/rustc-1.70+-blue.svg)](https://blog.rust-lang.org/2023/06/01/Rust-1.70.0.html)

A Rust library for generating EMVCo-compliant QR codes for payments according to the Ethiopian Interoperable QR Standard.

## Features

- EMVCo QR Code standard compliance
- Support for multiple payment schemes (Visa, Mastercard, IPS ET, etc.)
- Static and dynamic QR code generation
- Built-in validation and error handling
- QR code image generation** (enable with `qr-image` feature)

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
ethqr-gen = "0.1.0"

# For QR code image generation
ethqr-gen = { version = "0.1.0", features = ["qr-image"] }
```

## Quick Start

### Static QR Code (no amount specified)

```rust
use ethqr_gen::{QRBuilder, fields::SchemeConfig};

let qr_code = QRBuilder::new()
    .merchant_name("Coffee Shop")
    .merchant_city("Addis Ababa")
    .merchant_category_code("5812") // Restaurant
    .add_scheme(SchemeConfig::visa("4111111111111111"))
    .build()?;
```

### Dynamic QR Code (with specific amount)

```rust
use ethqr_gen::{QRBuilder, fields::{SchemeConfig, AdditionalData}};

let additional_data = AdditionalData::new()
    .bill_number("INV-001")
    .reference_label("ORDER-123");

let qr_code = QRBuilder::new()
    .merchant_name("Restaurant")
    .merchant_city("Dire Dawa")
    .merchant_category_code("5812")
    .add_scheme(SchemeConfig::ips_et(
        "581b314e257f41bfbbdc6384daa31d16",
        "CBETETAA",
        "10000171234567890",
    ))
    .transaction_amount("420.00")
    .additional_data(additional_data)
    .build()?;
```

### Multiple Payment Schemes

```rust
let qr_code = QRBuilder::new()
    .merchant_name("Supermarket")
    .merchant_city("Bahir Dar")
    .merchant_category_code("5411") // Grocery store
    .add_scheme(SchemeConfig::visa("4111111111111111"))
    .add_scheme(SchemeConfig::mastercard("5555555555554444"))
    .add_scheme(SchemeConfig::ips_et(
        "899c314e257f41bfbbdc6384dab49e15",
        "CBETETAA",
        "10000171234567890",
    ))
    .build()?;
```

## Supported Payment Schemes

| Scheme     | Method                       | Description                        |
| ---------- | ---------------------------- | ---------------------------------- |
| Visa       | `SchemeConfig::visa()`       | Visa payment cards                 |
| Mastercard | `SchemeConfig::mastercard()` | Mastercard payment cards           |
| UnionPay   | `SchemeConfig::unionpay()`   | UnionPay payment cards             |
| IPS ET     | `SchemeConfig::ips_et()`     | Ethiopian Interbank Payment System |

## Standards Compliance

This library implements:

- EMVCo QR Code Specification for Payment Systems
- Ethiopian Interoperable QR Standard
- ISO 4217 currency codes (ETB - Ethiopian Birr)
- ISO 3166-1 country codes (ET - Ethiopia)

## Examples

Check out the [`examples/`](examples/) directory for more comprehensive usage examples:

## Contributing

Contributions are always welcome!

## License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

<br>

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