https://github.com/alitnk/monopay

💳 A node.js package for making payment transactions with different payment gateways
https://github.com/alitnk/monopay

idpay iran iran-payment iranian iranian-bank node node-js node-payment nodejs nodejs-payment payir payment payment-gateway persian saman saman-bank shaparak zarinpal zibal

Last synced: 3 months ago
JSON representation

💳 A node.js package for making payment transactions with different payment gateways

• Host: GitHub
• URL: https://github.com/alitnk/monopay
• Owner: alitnk
• License: mit
• Created: 2021-10-04T18:47:57.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-13T09:17:06.000Z (9 months ago)
• Last Synced: 2024-10-14T08:27:15.294Z (8 months ago)
• Topics: idpay, iran, iran-payment, iranian, iranian-bank, node, node-js, node-payment, nodejs, nodejs-payment, payir, payment, payment-gateway, persian, saman, saman-bank, shaparak, zarinpal, zibal
• Language: TypeScript
• Homepage: https://monopay.js.org
• Size: 5.15 MB
• Stars: 114
• Watchers: 5
• Forks: 19
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Monopay - مونو‌پِی

![monopay](https://github.com/alitnk/monopay/raw/graphics/github-readme-logo.png)

![Intended Runtime Environment: Node.js](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)

![NPM Version](https://img.shields.io/npm/v/monopay?style=for-the-badge)

![License](https://img.shields.io/npm/l/monopay?style=for-the-badge)

![Last Comit](https://img.shields.io/github/last-commit/alitnk/monopay?style=for-the-badge)

A node.js package for making payment transactions with different Iranian IPGs with one single API. (Previously known as "Polypay")

مونو‌پِی یک پکیج نود جی اس برای انجام تراکنش‌های آنلاین با سرویس های درگاه پرداخت مختلف با یک رابط واحد است.

در صورتی که از پکیج خوشتون اومده، بهش استار بدید تا بیشتر دیده بشه و مشکلاتش زودتر برطرف بشن. 🙏

> لطفا قبل از استفاده در پروداکشن،‌ از پایدار بودن درایور مطمئن شوید. - [جدول پشتیبانی درایور ها](https://monopay.js.org/fa/drivers)

## 📖 Documentation

- [Documentation](https://alitnk.github.io/monopay/)

- [مستندات فارسی](https://alitnk.github.io/monopay/fa/)

## 🔌 Installation

For npm users:

```shell

npm install monopay

```

For yarn users:

```shell

yarn add monopay

```

## 🚀 Usage

- [Usage Guide](https://monopay.js.org/payment-procedure/)

- [نحوه استفاده به فارسی](https://monopay.js.org/fa/payment-procedure/)

## ⚒ Examples

### Getting a payment driver

```javascript

const driver = getPaymentDriver('zibal')({

  merchantId: 'merchant-id',

  sandbox: true,

});

```

### Requesting for payment

```javascript

const paymentInfo = await driver.request({

  amount: 200000, // IRR

  callbackUrl: 'mysite.com/callback',

});

```

### Verifying the payment in callback

```javascript

app.all('/callback', async (req, res) => {

  const receipt = await driver.verify(

    {

      amount: 200000, // IRR

      referenceId: 1234,

    },

    { ...req.query, ...req.body },

  );

  res.json({

    referenceId: receipt.referenceId,

    success: true,

    message: 'The payment transaction was successful.',

  });

});

```

A full example with express can be found [here](examples/express-javascript)

## 📜 TODO List

- [ ] Support for all the drivers

- [ ] Add NestJS module integration

- [ ] Examples for Koa, Fastify and NestJS

- [ ] "Re-brand" (Logo and banner)

## 🤝 Contribution

Please read [Contribution](CONTRIBUTING.md) and [Code Of Conduct](CODE_OF_CONDUCT.md).

## 📝 License

MIT License - Please see [License File](LICENSE) for more information.