Skip to content

shurjopay-plugins/sp-plugin-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

shurjoPay JavaScript plugin package

Made With Test Status NPM version

Official shurjoPay JavaScript 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 javascript application or framework (e.g. React, vue.js, Angular etc). Also it makes it easy for developers to integrate with shurjoPay v2.1 with just three API calls:

  1. makePayment: create and send payment processing request
  2. verifyPayment: verify payment status at shurjoPay

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

How to use this shurjoPay Plugin

To integrate the shurjoPay Payment Gateway in your JavaScript project do the following tasks sequentially.

Step 1: Install the plugin inside your project environment

npm install shurjopay-js

Step 2: Import the functions from package in your code as necessary and initiate payment method.

import {  makePayment, verifyPayment } from "shurjopay-js";
 const makePayment_details= await makePayment(your_order_id, form_data);
 const { checkout_url } = makePayment_details;

Checkout this react project to see this plugin in action.

Step 3: Setup configuration parameters for shurjopay plugin correctly in your application.

e.g. API endpoint URL, username, password, prefix for the order id and return URL. Create a shurjopay_config.js in the project directory with text similar like below:

const shurjopay_config = {
    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",
};

export { shurjopay_config };

Payment verification can be done after each transaction with shurjopay order id

const verifyPayment_details = await verifyPayment(sp_order_id);

NOTE: Please checkout this readme docs for react or vue.js projects.

References

  1. React sample project showing usage of the javascript plugin.
  2. Vanilla javascript sample project to get your feet wet with shurjopay.
  3. Sample applications and projects in many different languages and frameworks showing shurjopay integration.
  4. shurjoPay Postman site illustrating the request and response flow using the sandbox system.
  5. 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 ©️2022 ShurjoMukhi Limited.