Giter Club home page Giter Club logo

sp-plugin-nodejs's Introduction

alt text Nodejs package (plugin)

Made With Test Status NPM version

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.

SP_ENDPOINT=https://sandbox.shurjopayment.com
SP_USERNAME=sp_sandbox
SP_PASSWORD=pyyk97hu&6u6
SP_PREFIX=SP
SP_RETURN_URL=https://<your.app.com>/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.

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,
  );

}
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.

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 showing usage of the nodejs plugin.
  2. Sample applications and projects in many different languages and frameworks showing shurjopay integration.
  3. shurjoPay Postman site illustrating the request and response flow using the sandbox system.
  4. shurjopay Plugins home page on github

License

This code is under the MIT open source License.

Please contact with shurjoPay team for more detail.

Copyright ©️2023 ShurjoMukhi Limited

sp-plugin-nodejs's People

Contributors

anwar-me avatar imtiaz-rahi avatar shant00 avatar smukhiasif avatar smukhidev avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

sp-plugin-nodejs's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.