Spring Plugin

Official shurjoPay Spring plugin for merchants or service providers to connect with shurjoPay Payment Gateway v2.1 developed and maintained by ShurjoMukhi Limited.

This plugin can be used with spring application. Also it makes easy for developers to integrate with shurjoPay v2.1 with calling three methods only:

makePayment: create and send payment request
verifyPayment: verify payment status at shurjoPay
paymentStatus: Check payment details and status

Also reduces many of the things that you had to do manually:

Handles http request and errors.
JSON serialization and deserialization.
Authentication during initiating and verifying of payments.

Audience

This document is intended for the technical personnel of merchants and service providers who wants to integrate our online payment gateway using spring plugin provided by shurjoMukhi Limited.

How to use this shurjoPay plugin

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

Step 1: Add dependency into your spring project

Maven

<dependency>
  <groupId>bd.com.shurjomukhi</groupId>
  <artifactId>sp-plugin-spring</artifactId>
  <version>0.1.0</version>
</dependency>

Gradle

implementation 'bd.com.shurjomukhi:sp-plugin-spring:0.1.0'

Attention: shurjoMukhi offers separate plugin to integrate with any Java Application.

Step 2: Add below properties to project yml/properties file (e.g. application.yml, application.properties).

Properties contains four fields username, password, shurjopay-api, sp-callback to configure shurjoPay. Configure logging using these params path and name.

shurjopay:
  username: <merchant_username>
  password: <merchant_password>
  shurjopay-api: https://sandbox.shurjopayment.com/api
  sp-callback: https://sandbox.shurjopayment.com/response
  logging:
    file:
      path: /var/log
      name: sp-plugin-spring.log

See and copy this ready YML or properties.
Add logback-classic dependency in your application to get log messages generated by this plugin to track shurjoPay errors only (optional).

Step 3: After that, you can initiate payment request to shurjoPay using below code example.

   // Initialize shurjopay
   private @Autowired Shurjopay shurjopay;

   // Prepare payment request to initiate payment
   PaymentReq request = new PaymentReq();
   request.setPrefix("sp");
   request.setAmount(10.00);
   request.setCustomerOrderId("sp315689");
   request.setCurrency("BDT");
   request.setCustomerName("Dummy");
   request.setCustomerAddress("Dhaka");
   request.setCustomerPhone("01766666666");
   request.setCustomerCity("Dhaka");
   request.setCustomerPostCode("1212");
   request.setCustomerEmail("dummy@gmail.com");

   // Calls first method to initiate a payment
   shurjopay.makePayment(request);

Returns POJO corresponding this JSON

Step 4: Payment verification can be done after each transaction with shurjopay transaction id.

Call verify method

   shurjopay.verifyPayment(:=spTxnId)

Returns POJO corresponding this JSON

Want to see shurjoPay in action?

Run the JUnit test to see shurjopay plugin in action. These tests will run on selenium browser and will provide the complete experience. Just download source and run the command mvnw.cmd test in Windows and ./mvnw test in Linux from plugin root path.

References

Spring example application showing usage of the spring plugin.
Sample applications and projects in many different languages and frameworks showing shurjopay integration.
shurjoPay Postman site illustrating the request and response flow using the sandbox system.
shurjopay Plugins home page on github

License

This code is under the MIT open source License.

shurjopay-plugins/sp-plugin-spring