https://github.com/immmdreza/zarinpal
https://github.com/immmdreza/zarinpal
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/immmdreza/zarinpal
- Owner: immmdreza
- License: mit
- Created: 2023-10-01T15:30:27.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-10-06T12:43:14.000Z (over 1 year ago)
- Last Synced: 2025-02-28T15:08:54.533Z (4 months ago)
- Language: Rust
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zarinpal payment gateway api
This's a rust implementation of zarinpal payment gateway api client.
## Installation
```cmd
cargo add zarinpal
```
## Usage example
Here's how you can get started with the crate
### Initialize client
```rust
use zarinpal::prelude::*;
#[tokio::main]
async fn main() -> anyhow::Result<()> {
// Default merchant_id to be used in every request.
let zarinpal = Zarinpal::new("merchant_id")?;
Ok(())
}
```
### Request a basic payment
```rust
// ~~~ sniff ~~~
let request = zarinpal
.request_payment(10000, "example.com".parse()?, "Test payment")
.build()
.await?;
```
### Verify a payment
```rust
// ~~~ sniff ~~~
let verified = zarinpal
.verify_payment(request.authority(), 10000)
.build()
.await?;
```
### Request payment with metadata
```rust
// ~~~ sniff ~~~
let request_2 = zarinpal
.request_payment(10000, "example.com".parse()?, "Test payment")
.metadata(
Metadata::builder()
.mobile("98912345678")
.email("[email protected]")
.build(),
)
.build()
.await?;
```
### Change currency in a payment
```rust
// ~~~ sniff ~~~
let request_3 = zarinpal
.request_payment(10000, "example.com".parse()?, "Test payment")
.currency(Currency::IRT) // Tomans
.build()
.await?;
```
### Payment request with wages
```rust
// ~~~ sniff ~~~
let request_4 = zarinpal
.request_payment(10000, "example.com".parse()?, "Test payment")
.wages([
Wage::builder()
.iban("...")
.amount(5000)
.description("To my first friend")
.build(),
Wage::builder()
.iban("...")
.amount(5000)
.description("To my second friend")
.build(),
])
.build()
.await?;
```
### Unverified payments
Revert a list of 100 recent unverified payments.
```rust
// ~~~ sniff ~~~
let unverified_payments = zarinpal.unverified_requests().build().await?;
for unverified in unverified_payments.authorities() {
println!("{}", unverified.authority())
}
```
Happy making money 🔥