ecommpay

0.1.7 • Public • Published

EcommPay Javascript package

Build Status Test Coverage Maintainability

What is it?

It is package that will help you with generating payment URL according to EcommPay documentation.

How to use?

Get payment page URL

  1. Install the package (with your package manager):
npm install ecommpay
yarn add ecommpay
  1. Require somewhere in your code, set parameters and get the URL:
const { Payment } = require('ecommpay');
 
// create ECP object with your account ID and secret salt
const e = new Payment('112', 'my_secret');
 
// set payment details 
e.paymentAmount = 1000;
e.paymentId = 'FFCD12-30';
e.paymentCurrency = 'USD';
 
// set another parameters, like success or fail callback URL, customer details, etc.
 
// get payment URL
const url = e.getUrl();

Now your can render payment url somewhere on your checkout page.

Receive callback from Ecommpay

Example with Express:

const { Callback } = require('ecommpay');
 
app.post('/payment/callback', function(req, res) {
  const callback = new Callback('secret', req.body);
  if (callback.isPaymentSuccess()) {
    const paymentId = callback.getPaymentId();
    // here is your code for success payment
  }
});

Note that Callback constructor throws Error if signature isn't valid.

Readme

Keywords

none

Package Sidebar

Install

npm i ecommpay

Weekly Downloads

2,540

Version

0.1.7

License

MIT

Unpacked Size

9.6 kB

Total Files

8

Last publish

Collaborators

  • zhukovra
  • ugnku