@zokshpay/sdk-nodejs

Node.js SDK for Zoksh payment gateway integration.

Repo aim is to simplify api integration.

Please go throught Official documentation to get overview of how payment integration works.

Installation

$ npm install --save-exact @zokshpay/sdk-nodejs

Initialize

const Zoksh = require('@zokshpay/sdk-nodejs').Zoksh;
// by default it makes connection to testnet, pass in false as third argument to connect to production servers.
const mp = new Zoksh(apiKey, apiSecret);

Create Order

Please checkout Order options to see all possible options available during order creation.

const orderOptions = {amount: 1};

// create method returns a promise, you can either use async/await or handle the promise yourself.
const order = mp.order.create(orderOptions);
order.then(result => {
    // called on successful creation of order
}).catch(err => {
    // an error occured during order creation.
})

Validate Payment

Please check Payment validation for more details.

const transactionHash = '0x01d18ad4f395eec42678c6564d2820b18986b3ed012527f0bf5c22ef1450fc83';
mp.payment.validate(transactionHash).then(result => {
    // called on successful request.
}).catch(err => {
    // an error occured during payment validation
})

Validate webhook

Please check Webhook for more details.

// setup the webhook end point that you have added in the your dashboard settings.
mp.webhookEndPoint = 'YOUR_FULL_END_POINT_URL';
const webhook = mp.webhook;
// to test a request like object. which has *headers*, and *body* property
try {
    const result = webhook.test(req);
    // result is *true* if valid signature found.
} catch(e) {
    console.error(e);
}
// to test headers and body directly.
try {
    const result = webhook.handle(headers, body);
    // result is *true* if valid signature found.
} catch(e) {
    console.error(e);
}
// to use as *express* middleware,
app.post('/webhook', webhook.express, (req, res, next) => {

});