https://github.com/shurjopay-plugins/sp-plugin-nodejs
shurjoPay plugin for nodejs applications
https://github.com/shurjopay-plugins/sp-plugin-nodejs
javascript node npm payment-gateway shurjomukhi shurjopay strapi-cms
Last synced: about 1 year ago
JSON representation
shurjoPay plugin for nodejs applications
- Host: GitHub
- URL: https://github.com/shurjopay-plugins/sp-plugin-nodejs
- Owner: shurjopay-plugins
- License: mit
- Created: 2022-01-25T08:04:59.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-17T05:55:45.000Z (over 2 years ago)
- Last Synced: 2025-04-25T18:58:17.417Z (about 1 year ago)
- Topics: javascript, node, npm, payment-gateway, shurjomukhi, shurjopay, strapi-cms
- Language: JavaScript
- Homepage:
- Size: 53.7 KB
- Stars: 8
- Watchers: 0
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#  Nodejs package (plugin)
[]()
Official shurjoPay nodejs package (plugin) for merchants or service providers to connect with shurjoPay Payment Gateway v2.1 developed and maintained by shurjoMukhi Limited.
This plugin package can be used with any nodejs application or framework .
This plugin package makes it easy for you to integrate with shurjoPay v2.1 with just three method calls:
- makePayment()
- verifyPayment()
- paymentStatus()
Also reduces many of the things that you had to do manually
- Handles http request and errors
- JSON serialization and deserialization
- Authentication during checkout and verification of payments
## Audience
This document is intended for the developers and technical personnel of merchants and service providers who want to integrate the shurjoPay online payment gateway using python.
## How to use this shurjoPay Plugin
#### Use `npm` to install this plugin inside your project environment.
```
npm install shurjopay
```
#### Create a .env file inside your project's root directory. Here is a sample .env configuration.
```JavaScript
SP_ENDPOINT=https://sandbox.shurjopayment.com
SP_USERNAME=sp_sandbox
SP_PASSWORD=pyyk97hu&6u6
SP_PREFIX=SP
SP_RETURN_URL=https:///shurjopay-response
```
#### After that, you can initiate payment request to shurjoPay using our package the way you want based on your application. Here we are providing a basic example code snippet for you.
```JavaScript
require("dotenv").config();
const shurjopay = require("shurjopay")();
// For ES6/nextjs need to add the following lines instead of constant declaration above
import spfactory from 'shurjopay';
const shurjopay = spfactory();
with(process.env){
shurjopay.config(
SP_ENDPOINT,
SP_USERNAME,
SP_PASSWORD,
SP_PREFIX,
SP_RETURN_URL,
);
}
```
```JavaScript
shurjopay.makePayment({
"amount":1000,
"order_id":"nx10t1",
"customer_name":"Shanto",
"customer_address":"Mohakhali",
"client_ip": "102.324.0.5",
"customer_phone":"01517162394",
"customer_city":"Dhaka",
"customer_post_code":"1229",
},
(response_data) => {
// TODO Handle response from shurjopay and update your system
// NOTE 'checkout_url' in response_data can be used to redirect consumers to shurjopay landing page
},
(error) => {
// TODO Handle error response
});
```
#### Payment verification can be done after each transaction with shurjopay order id.
```JavaScript
shurjopay.verifyPayment(order_id, (response_data) => {
// TODO Handle response from shurjopay and update your system
},
(error) => {
// TODO Handle error response
});
```
#### That's all! Now you are ready to use the nodejs plugin to seamlessly integrate with shurjoPay to make your payment system easy and smooth.
## References
1. [Nodejs example application](https://github.com/shurjopay-plugins/sp-plugin-usage-examples/tree/main/node-app-node-plugin) showing usage of the nodejs plugin.
2. [Sample applications and projects](https://github.com/shurjopay-plugins/sp-plugin-usage-examples) in many different languages and frameworks showing shurjopay integration.
3. [shurjoPay Postman site](https://documenter.getpostman.com/view/6335853/U16dS8ig) illustrating the request and response flow using the sandbox system.
4. [shurjopay Plugins](https://github.com/shurjopay-plugins) home page on github
## License
This code is under the [MIT open source License](LICENSE).
#### Please [contact](https://shurjopay.com.bd/#contacts) with shurjoPay team for more detail.
### Copyright ©️2023 [ShurjoMukhi Limited](https://shurjopay.com.bd/)