AKS-QMS-P10-006

INTEGRATION USER GUIDE

“JazzCash Plugin
Merchant Integration User Guide
(WooCommerce)”
 AKSA-SDS
AKS-QMS-P10-006

Copyright Note and Disclaimer

All rights reserved. Neither complete nor any part of this user guide, the text or graphics thereof may be distributed or reproduced in any
material form or transmitted to any other person in any form or by any means, including photocopying, recording, or other electronic or
mechanical methods, either voluntarily or otherwise, without the express prior written permission of AKSA-SDS.

Every reasonable precaution has been taken while preparing this user guide. However, the contents of this user guide are furnished for
information purposes only and are subject to change without notice, consequently, not to be construed as a commitment by AKSA-SDS.
Therefore, AKSA-SDS assumes no responsibility or liability for any errors or inaccuracies that may appear in the contents of this user guide.
Accordingly, AKSA-SDS, its shareholders, directors, officers, managers, employees, agents and representatives do not accept any liability and will
not be liable for any loss or damage arising directly or indirectly (including special, incidental or consequential loss or damage) from the use of
and/or reliance placed on this user guide including any loss, damage or expense arising from, but not limited to, any defect, error, imperfection,
fault, mistake or inaccuracy with this user guide, its contents or associated services, or due to any unavailability of the information contained in
the user guide.

Integration Guide
1
 AKSA-SDS
AKS-QMS-P10-006

Table of Contents
1 Document Control ............................................................................................................3
1.1 History................................................................................................................................ 3
1.2 Revision History .................................................................................................................. 3
2 Introduction .....................................................................................................................4
2.1 Requirements ..................................................................................................................... 4
3 Getting Started ................................................................................................................4
3.1 WordPress Login ................................................................................................................. 4
4 Integration Steps .............................................................................................................6
4.1 Installation ......................................................................................................................... 6
4.2 Configuration ...................................................................................................................... 9

Integration Guide
1
 AKSA-SDS
AKS-QMS-P10-006

Table of Figures
Figure 1: Login ................................................................................................................................................................ 5
Figure 2: Dashboard ....................................................................................................................................................... 6
Figure 3: Navigation Panel.............................................................................................................................................. 7
Figure 4: Add New .......................................................................................................................................................... 8
Figure 5: Upload Module ................................................................................................................................................ 8
Figure 6: Upload Package File......................................................................................................................................... 9
Figure 7: Activate Plugin ................................................................................................................................................. 9
Figure 8: Configure Module .......................................................................................................................................... 10
Figure 9: JazzCash Method ........................................................................................................................................... 11
Figure 10: JazzCash Method ......................................................................................................................................... 11
Figure 11: JazzCash Method ......................................................................................................................................... 12

Integration Guide
2
 AKSA-SDS
AKS-QMS-P10-006

1 Document Control
1.1 History

Version # Date Assigned By Author Task

1.0 November 28, 2018 Sami ur Rehman Samia Mazhar Integration User Guide

1.2 Revision History

Version # Date Reviewed By Approved By Task

1.0 November 28, 2018 Abdus Subhan Sami ur Rehman Review Document

Integration Guide
3
 AKSA-SDS
AKS-QMS-P10-006
2 Introduction
The JazzCash plugin can be easily and seamlessly integrated into an existing website, web store or
any of your online presence (blog) that is built using Wordpress containing WooCommerce plugin.
Once the plugin has been successfully integrated, the JazzCash payment method will be added to the
wordpress site with three new payment methods (JazzCash Shop; JazzCash MWallet; JazzCash Card)
for the JazzCash payment gateway. This plugin is built upon Wordpress v 4.9.8 website supporting
WooCommerce v 3.5.1.

2.1 Requirements

 This JazzCash module has been tested with Wordpress 4.9.8

 This JazzCash module will support version up to WooCommerce v 3.5.1

3 Getting Started
This section provides step by step instructions on integrating JazzCash module.

3.1 WordPress Login

To access WordPress Dashboard, you must first log into your account by providing login credentials
as shown below.

Integration Guide
4
 AKSA-SDS
AKS-QMS-P10-006

Enter Email or
Username here

Enter
Password here

Click Login after

providing above
information

Figure 1: Login

 Enter Email Address or Username

 Enter Password
 Click Login
After successful login, the Dashboard will display as shown below.

Integration Guide
5
 AKSA-SDS
AKS-QMS-P10-006

Figure 2: Dashboard

4 Integration Steps
There are two steps in integrating JazzCash module as listed below:
1. Installation
2. Configuration

4.1 Installation
The first step in integration is installing the module.

Integration Guide
6
 AKSA-SDS
AKS-QMS-P10-006

Click here

Figure 3: Navigation Panel

Perform the following steps on the Dashboard:

 Click & Expand Plugins in Navigation Panel as shown below. The following sub-menu will
load in Plugins as shown in the following screenshot:
o Installed Plugins
o Add New
o Editor

Integration Guide
7
 AKSA-SDS
AKS-QMS-P10-006

Click here after clicking Add New in

Navigation Panel

Click here
to add
new
plugin

Figure 4: Add New

 Click Add New under Plugins in Navigation Panel. The Plugins interface will display on the
right side of Navigation Panel.
Upon clicking Add New button, the Add Plugins interface will display as shown above.
 Click Add New Button.

Click here

Click here

Figure 5: Upload Module

 Click on Upload Plugin button

 Click on Choose File button

Integration Guide
8
 AKSA-SDS
AKS-QMS-P10-006

Double-click
to attach file

Figure 6: Upload Package File

 Browse & Select jazzcash.zip file from WooCommerce folder

After successfully uploading the file, success message will appear as shown below.

Success Message appears here

Click
here

Figure 7: Activate Plugin

 Click on Activate Plugin button to complete the installation.

4.2 Configuration
The next step in integration is to configure JazzCash payment method by performing the following
steps shown below.

Integration Guide
9
 AKSA-SDS
AKS-QMS-P10-006

Click
WooCommerce

Click
Settings

Figure 8: Configure Module

 Click WooCommerce
 Click Settings

Integration Guide
10
 AKSA-SDS
AKS-QMS-P10-006

Click here

Figure 9: JazzCash Method

 Click Payments Tab

 Scroll down to Payment Methods. JazzCash payment method will be listed in disabled mode.

Click here

JazzCash Payment Method will be disabled

Figure 10: JazzCash Method

 Click Manage button

Integration Guide
11
 AKSA-SDS
AKS-QMS-P10-006
 Click Enable / Disable checkbox to enable payment method

Click this
checkbox

Configure these
variables

Click this
checkbox
Click here

Figure 11: JazzCash Method

 Configure the variables according to the environment you are using. The Following variables
are configurable:
o Merchant ID: Enter Merchant ID associated to your JazzCash merchant account.
o Password: Enter password of your JazzCash account
o Return URL: Enter the Return URL to get the response from payment gateway. The
Return URL must be https to ensure security and protection of sensitive information.
The Return URL must contain the site URL followed by the module as shown below:
( (SITE_URL) /?wc-api=jazzcashresponse )

Enter live Site URL here

Integration Guide
12
 AKSA-SDS
AKS-QMS-P10-006
o Transaction Expiry (Hours): This field sets the inactive timeout for OTC /Credit Card /
MWallet transactions. Enter an integer value to allow for automatic timeout after
Number of Hours of user inactivity.
o Integrity Salt: Enter the Key to encrypt data on the page.
o Transaction Post URL: Enter the Transaction Post URL provided by Jazz. This URL will
call JazzCash Payment Gateway after the user selects payment mode. The user will be
redirected to Transaction Post URL for further processing after selecting mode of
payment.
o Web Services / WSDL: Enter WSDL Service link that will be used for Instant Payment
Notification (IPN) Handling. The WSDL service shall update order status in Database.
The WSDL Service link must be https and contain the site URL followed by the module
as shown below:

((SITE_URL)/wp-content/plugins/jazzcash-woocommerce-gateway/wsdl/index.php?wsdl)

Enter live Site URL here

 Click Validate Hash checkbox

 Click Save

After successfully completing the installation and configuration steps, JazzCash payment method will
be enabled in WooCommerce and consequently on your Wordpress site.

Integration Guide
13