Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shahriar-shojib/bkash-payment-gateway
Nodejs library to accept bKash payments on your backend application
https://github.com/shahriar-shojib/bkash-payment-gateway
bkash bkash-online-payment bkash-payment bkash-payment-gateway bkash-pgw javascript nodejs npm typescript
Last synced: 10 days ago
JSON representation
Nodejs library to accept bKash payments on your backend application
- Host: GitHub
- URL: https://github.com/shahriar-shojib/bkash-payment-gateway
- Owner: shahriar-shojib
- License: mit
- Created: 2020-12-16T08:01:59.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-05T14:32:43.000Z (over 1 year ago)
- Last Synced: 2024-10-13T22:53:23.517Z (23 days ago)
- Topics: bkash, bkash-online-payment, bkash-payment, bkash-payment-gateway, bkash-pgw, javascript, nodejs, npm, typescript
- Language: TypeScript
- Homepage:
- Size: 245 KB
- Stars: 82
- Watchers: 3
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# bkash-payment-gateway
Nodejs library to accept bkash payments on your backend application
## Examples
- [Express](https://github.com/shahriar-shojib/bkash-payment-gateway/tree/main/examples)
## Features
- Implements all the methods required to get accepted as a merchant on bKash
- Written in typescript
- Get intellisense in when interacting with the library `vscode`
- Get Documentation and examples right inside your code editor `vscode`
- Get Bkash Response Intellisense
- Abort Request when an executePayment request exceeds `30 seconds` and get an error so that you can query the payment
- Get Human Readable exceptions when some error response is returned from bKash `in progress`
---
# How to use
## Installing the library
### `npm`
> `npm install bkash-payment-gateway`
### `yarn`
> `yarn add bkash-payment-gateway`
---
## Initializing the library
### `javascript`
> file `bkash.js`
```javascript
const { BkashGateway } = require('bkash-payment-gateway');
const bkashConfig = {
baseURL: 'https://checkout.sandbox.bka.sh/v1.2.0-beta', //do not add a trailing slash
key: 'abcdxx2369',
username: 'bkashTest',
password: 'bkashPassword1',
secret: 'bkashSup3rS3cRet',
};
const bkash = new BkashGateway(config);
module.exports = bkash;
```
### `typescript`
> file `bkash.ts`
```typescript
import { BkashGateway ICreatePayment } from 'bkash-payment-gatway';
const bkashConfig: ICreatePayment = {
//get intellisense here
baseURL: 'https://checkout.sandbox.bka.sh/v1.2.0-beta', //do not add a trailing slash
key: 'abcdxx2369',
username: 'bkashTest',
password: 'bkashPassword1',
secret: 'bkashSup3rS3cRet',
};
const bkash = new BkashGateway(config);
export default bkash;
```
---
## Create a payment
```javascript
const paymentRequest = {
amount: 1000,
orderID: 'ORD1020069',
intent: 'sale',
};
const result = await bkash.createPayment(paymentRequest);
console.log(result);
```
---
## Execute a payment with payment ID
```javascript
const result = await bkash.executePayment('');
```
---
## Query a payment with payment ID
```javascript
const result = await bkash.queryPayment('');
```
---
## Search Transaction
```javascript
const result = await bkash.searchTransaction('TRX22347463XX');
```
---
## Refund a transaction
```javascript
const refundTransactionData = {
paymentID: '22423169',
amount: '25.69', //do not add more than two decimal points
trxID: 'TRX22347463XX';
sku: 'SK256519';
}
const result = await bkash.refundTransaction(refundTransactionData);
```
---
## Check Refund Status
```javascript
const result = await bkash.refundStatus('TRX22347463XX', '12437969');
```
---
### 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 **`Bkash`** 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)