Nodejs Package For Clickpay PT2

Description

This Package provides integration with the Clickpay payment gateway.

CONTENTS OF THIS FILE

• Introduction
• Requirements
• Installation

INTRODUCTION

This Package integrates Clickpay online payments into the Nodejs Project.

REQUIREMENTS

This module requires - axios - qs

INSTALLATION

• Install Via NPM:

  • npm i clickpay_pt2

• Github Repo Link:

  • https://github.com/clickpaysa/clickpay-nodejs-package

EXAMPLES

*Init The Package:

const clickpay = require('clickpay_pt2');
clickpay.setConfig(<profile_id>,<server_key>,<region>);

*Create Pay Page:

clickpay.createPaymentPage([<payment_methods>],['sale','ecom'],[<cart_id>,<cart_currency>,<cart_amount>,<cart_description>],
[<customer_name>,<customer_email>,<customer_phone>,<customer_address>,<customer_city>,<customer_state>,<customer_country>,<customer_Zip>,<customer_ip>],
[<shipping_name>,<shipping_email>,<shipping_phone>,<shipping_address>,<shipping_city>,<shipping_state>,<shipping_country>,<shipping_Zip>,<shipping_ip>],
[<callback>,<return_url>],
<paypage_lang>,callback
)


function createPayPage(result)
{
console.log(result);
}

-Parameters Example
clickpay.createPaymentPage(['all'],['sale','ecom'],['cart_22222','EGP','100','test'],
  ['walaa Elsaeed','email@domain.com','0522222222','address street','Egypt','egypt','EG','12345','1.1.1.1'],
  ['walaa Elsaeed','email@domain.com','0522222222','address street','Egypt','egypt','EG','12345','1.1.1.1'],
  ['https://webhook.site/730acce0-e54e-4522-8a45-f9b8e44624b6','https://clickpay.com.sa/wps/portal/clickpaynew'],
  'en',createPayPage
  )

- if you want to use framed paypage you should pass parameter framed = true .
 clickpay.createPaymentPage(['all'],['sale','ecom'],['cart_22222','EGP','100','test'],
  ['walaa Elsaeed','email@domain.com','0522222222','address street','Egypt','egypt','EG','12345','1.1.1.1'],
  ['walaa Elsaeed','email@domain.com','0522222222','address street','Egypt','egypt','EG','12345','1.1.1.1'],
  ['https://webhook.site/730acce0-e54e-4522-8a45-f9b8e44624b6','https://clickpay.com.sa/wps/portal/clickpaynew'],
  'en',createPayPage,True
  )

*Validate Payment:

clickpay.validatePayment(<transRef>,<callback>);


function verifyPayment(result)
{
    if (result['response_code:'] === 400)
    {
        console.log('false');
    }
    else
    {
        console.log('true');
    }
}

-Parameters Example
clickpay.validatePayment('TST2109000130191',verifyPayment);

*Refund:

clickpay.queryTransaction([<transRef>,'refund','ecom'],[<cart_id>,<cart_currency>,<cart_amount>,<cart_description>],callback);


function refunTrans(result){
if (result['response_code:'] === 400)
    {
        console.log('Unable to process your request, please make sure of your TransRef');
    }
    else
    {
        console.log(result);
    }
}

-Parameters Example
clickpay.queryTransaction(['TST2108800126691','refund','ecom'],['cart_22222','EGP','100','test'],refunTrans);

• important notes:

  -Make sure that your website currency is as same as your currency in clickpay profile. -Make sure that you send the region as the syntax below:

  Send ARE if your region is United Arab Emirates. Send SAU if your region is Saudi Arabia.