https://github.com/shahriar-shojib/nagad-payment-gateway

Node.js Library for accepting payments from Nagad
https://github.com/shahriar-shojib/nagad-payment-gateway

javascript nagad nagad-api nagad-api-library nagad-gateway nagad-payment nodejs npm npm-library typescript

Last synced: about 2 months ago
JSON representation

Node.js Library for accepting payments from Nagad

• Host: GitHub
• URL: https://github.com/shahriar-shojib/nagad-payment-gateway
• Owner: shahriar-shojib
• License: mit
• Created: 2020-12-16T10:35:33.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-18T19:02:04.000Z (about 2 years ago)
• Last Synced: 2024-10-13T22:53:23.623Z (2 months ago)
• Topics: javascript, nagad, nagad-api, nagad-api-library, nagad-gateway, nagad-payment, nodejs, npm, npm-library, typescript
• Language: TypeScript
• Homepage:
• Size: 148 KB
• Stars: 29
• Watchers: 1
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nagad-payment-gateway

[![Test Suite](https://github.com/shahriar-shojib/nagad-payment-gateway/actions/workflows/test.yml/badge.svg)](https://github.com/shahriar-shojib/nagad-payment-gateway/actions/workflows/test.yml)

[![Release](https://github.com/shahriar-shojib/nagad-payment-gateway/actions/workflows/release.yml/badge.svg)](https://github.com/shahriar-shojib/nagad-payment-gateway/actions/workflows/release.yml)

Nodejs library to accept nagad payments on your backend application

## Features

- Written in Typescript

- No headaches when doing cryptographic operations, everything is handled inside the library.

- Get Intellisense with vscode to avoid errors

- Type definitions included, and all the documentation is provided as `TSDoc` comments

---

# How to use

## Installing the library

### `npm`

> `npm install nagad-payment-gateway`

### `yarn`

> `yarn add nagad-payment-gateway`

---

## Initializing the library

### `javascript`

> file `nagad.js`

```javascript

const { NagadGateway } = require('nagad-payment-gateway');

const config = {

	apiVersion: 'v-0.2.0',

	baseURL: process.env.BASE_URL,

	callbackURL: process.env.CALLBACK_URL,

	merchantID: process.env.MERCHANT_ID,

	merchantNumber: process.env.MERCHANT_NUMBER,

	privKey: '.keys/private.key',

	pubKey: '.keys/public.key',

	isPath: true,

};

const nagad = new NagadGateway(config);

module.exports = nagad;

```

### `typescript`

> Todo

---

## Create a payment

```javascript

try {

	const nagadURL = await nagad.createPayment({

		// -> get intellisense here

		amount: '100',

		ip: '10.10.0.10',

		orderId: `${Date.now()}`,

		productDetails: { a: '1', b: '2' },

		clientType: 'PC_WEB',

	});

	//redirect user to the nagad url

} catch (err) {

	console.log(err);

}

```

## Verify a payment

```javascript

try {

	const nagadURL = await nagad.verifyPayment(paymentRefID);

	//redirect user to the nagad url

} catch (err) {

	console.log(err);

}

```

> More documentation coming soon

---

### Contributing

- Please Follow the code style and use the prettier config and eslint config provided in the repository

- Feel free to open `issues` or `pull request` for any issues and bugfixes

- If you want to implement new features or write documentation about existing features feel free to do it as well

- To see a list of missing features or to-do's, please visit the `project` section of the github repository

---

### License

> MIT

> DISCLAIMER: This software comes with absolutely no warranty and is not affiliated with the company **`Nagad`** in any way. Use at your own risk. Author and Contributors are not responsible for any financial damages, outages etc.

### Author

[Shahriar Shojib](https://github.com/shahriar-shojib)