ssl-commerz-node v1.0.4

SSLCOMMERZ Payment Gateway integration in NodeJs (with MERN example)

It is npm package which provides functionalities to implement SSLCommerz Payment Gateway in Node Based Apps.

Installation

Via NPM

npm i ssl-commerz-node

Via YARN

yarn add ssl-commerz-node

MERN Stack Example (demo)

• Project Github repo
• Live Demo: https://sslcommerz.netlify.app

Set the parameters to make a request

const SSLCommerz = require("ssl-commerz-node");
const PaymentSession = SSLCommerz.PaymentSession;
require("dotenv").config();

// For live payment set first parameter `false` and for sandbox set it `true`
const payment = new PaymentSession(
  true,
  process.env.SSLCOMMERZ_STORE_ID,
  process.env.SSLCOMMERZ_STORE_PASSWORD
);

// Set the urls
payment.setUrls({
  success: "yoursite.com/success", // If payment Succeed
  fail: "yoursite.com/fail", // If payment failed
  cancel: "yoursite.com/cancel", // If user cancel payment
  ipn: "yoursite.com/ipn", // SSLCommerz will send http post request in this link
});

// Set order details
payment.setOrderInfo({
  total_amount: 1570, // Number field
  currency: "BDT", // Must be three character string
  tran_id: "ref12345667", // Unique Transaction id
  emi_option: 0, // 1 or 0
  multi_card_name: "internetbank", // Do not Use! If you do not customize the gateway list,
  allowed_bin: "371598,371599,376947,376948,376949", // Do not Use! If you do not control on transaction
  emi_max_inst_option: 3, // Max instalment Option
  emi_allow_only: 0, // Value is 1/0, if value is 1 then only EMI transaction is possible
});

// Set customer info
payment.setCusInfo({
  name: "Simanta Paul",
  email: "simanta@bohubrihi.com",
  add1: "66/A Midtown",
  add2: "Andarkilla",
  city: "Chittagong",
  state: "Optional",
  postcode: 4000,
  country: "Bangladesh",
  phone: "010000000000",
  fax: "Customer_fax_id",
});

// Set shipping info
payment.setShippingInfo({
  method: "Courier", //Shipping method of the order. Example: YES or NO or Courier
  num_item: 2,
  name: "Simanta Paul",
  add1: "66/A Midtown",
  add2: "Andarkilla",
  city: "Chittagong",
  state: "Optional",
  postcode: 4000,
  country: "Bangladesh",
});

// Set Product Profile
payment.setProductInfo({
  product_name: "Computer",
  product_category: "Electronics",
  product_profile: "general",
});

See this for details: https://developer.sslcommerz.com/doc/v4/#ready-the-parameters

After setting the parameters initialize the payment

// use SSLCommerz_payment_init function/controller for payment request
exports.SSLCommerz_payment_init = async (req, res) => {
  // Initiate Payment and Get session key
  payment.paymentInit().then((response) => {
    console.log(response);
    // res.send(response);
  });
}

This link containes details about the response parameters: https://developer.sslcommerz.com/doc/v4/#returned-parameters

Response Parameters Examples

After Success

console.log(response["status"]);

SUCCESS

console.log(response["sessionkey"]);

D37CD2C0A0D322991531D217E194F981

console.log(response["GatewayPageURL"]);

https://sandbox.sslcommerz.com/EasyCheckOut/testcded37cd2c0a0d322991531d217e194f981

After Failure (Wrong Store ID)

console.log(response["status"]);

FAILED

console.log(response["failedreason"]);

Store Credential Error Or Store is De-active

The GatewayPageURL is the url of the payment page.