Merchant Onboarding

The Basics
API References
Features
Resources
FAQ

JazzCash Documentation v4.2

API References

Introduction

This API reference document contains a brief description of the available API’s with clearly defined input and output parameters on the right side under the title ‘Parameter description’. Request and response bodies are also provided along with each API with sample data for clear understanding.

Card API's

Following card based API’s are available with detailed description and relevant information.

Initiate Authentication

This is a request to check a cardholder's enrollment in the initiate authentication scheme.

Request Body

{ "pp_Version": "2.0", "pp_IsRegisteredCustomer": "Yes", "pp_ShouldTokenizeCardNumber": "Yes", "pp_TxnType": "MPAY", "pp_TxnRefNo": "T20221125153218", "pp_MerchantID": "Test00127801", "pp_Password": "0123456789", "pp_Amount": "20000", "pp_TxnCurrency": "PKR", "pp_TxnDateTime": "20221125153215", "pp_TxnExpiryDateTime": "20221202153215", "pp_BillReference": "billRef", "pp_Description": "Description of transaction", "pp_CustomerCardNumber": "5123456789012346", "pp_UsageMode": "API", "pp_SecureHash": "" }

Response Body

{ responseCode": "000", responseMessage": "Thank you for Using JazzCash, your transaction was successful.", authenticationStatus": "AUTHENTICATION_SUCCESSFUL", status": "SUCCESS", gatewayRecommendation": "PROCEED", html": <div id=\"threedsFrictionLessRedirect\" xmlns=\"http://www.w3.org/1999/html\"> <iframe id=\"challengeFrame\" name=\"challengeFrame\"> </iframe> <form id=\"threedsFrictionLessRedirectForm\" method=\"POST\" action=\"http://localhost/MerchantSimulator/merchant/testview\" target=\"challengeFrame\"> <input type=\"hidden\" name=\"order.id\" value=\"RAFAYKHAN7T20221127183304\" /> <input type=\"hidden\" name=\"transaction.id\" value=\"221127664007\" /> <input type=\"hidden\" name=\"response.gatewayRecommendation\" value=\"PROCEED\" /> <input type=\"hidden\" name=\"result\" value=\"SUCCESS\" /> </form> <script id=\"authenticate-payer-script\"> var e = document.getElementById(\"threedsFrictionLessRedirectForm\"); if (e) { e.submit(); if (e.parentNode !== null) { e.parentNode.removeChild(e); } } </script> </div>", "secureHash": "" }

Parameter Description

Input Parameters

Parameter	Description
"pp_Version"	API Version. Fixed value ‘1.1’ or ‘2.0’ should be used.
"pp_IsRegisteredCustomer"	This parameter can be accessible from 2.0 version. It represents that the request has been made by the registered or a guest customer of a merchant.
"pp_ShouldTokenizeCardNumber"	This parameter can be accessible from 2.0 version. It will generate token against the given card details.
"pp_TxnType"	Presents the transaction type: MPAY – Direct Pay Mode AUTH – Authorize/Capture Mode
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_TxnDateTime"	Merchant provided date and time of transaction. The format of date time should be yyyyMMddHHmmss.
"pp_TxnExpiryDateTime"	Transaction Expiry can be specified by merchant to indicate to the issuing bank that the transaction must be approved within this period. Please note that the default and maximum value of this expiry is 3 months.
"pp_BillReference"	Bill/invoice Number being settled.
"pp_Description"	Transaction details to be shown on screen as desired by the merchant. This field will be parsed to identify any malicious data entered by the end user. In cases when any of these characters <>\*=%/:'\|"{} are inserted, they will be replaced with a space.
"pp_CustomerCardNumber"	Card number of the customer making the payment.
"pp_UsageMode"	Represent the usage mode that is API:Initiate Authentication From API PR:Initiate Authentication From PR (Page Redirection Or Landing Page)
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter	Description
"responseCode"	Success / Failure Response code.
"responseMessage"	Response message receive in case of success and failure.
"authenticationStatus"	If user is egligible for authentication or not.
"status"	Status receive in case of success and failure.
"gatewayRecommendation"	Gateway Recommedation represent if customer can proceed or not.
"secureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Initiate Authentication Via Token

This is a request to check a cardholder's enrollment in the Initiate Authentication scheme using Token against their already saved card.This request is specific for returning customer transaction.

Request Body

{ "pp_Version": "2.0", "pp_IsRegisteredCustomer": "Yes", "pp_ShouldTokenizeCardNumber": "Yes", "pp_TxnType": "MPAY", "pp_TxnRefNo": "T20221125153224", "pp_MerchantID": "Test00127801", "pp_Password": "0123456789", "pp_Amount": "20000", "pp_TxnCurrency": "PKR", "pp_TxnDateTime": "20221125153215", "pp_TxnExpiryDateTime": "20221202153215", "pp_BillReference": "billRef", "pp_Description": "Description of transaction", "pp_TokenizedCardNumber":"9228924639592086", "pp_UsageMode": "API", "pp_SecureHash": "" }

Response Body

{ "responseCode": "000", "responseMessage": "Thank you for Using JazzCash, your transaction was successful.", "authenticationStatus": "AUTHENTICATION_AVAILABLE", "status": "SUCCESS", "gatewayRecommendation": "PROCEED", "secureHash": "" }

Parameter Description

Input Parameters

Parameter	Description
"pp_Version"	API Version. Fixed value ‘1.1’ or ‘2.0’ should be used.
"pp_IsRegisteredCustomer"	This parameter can be accessible from 2.0 version. It represents that the request has been made by the registered or a guest customer of a merchant.
"pp_ShouldTokenizeCardNumber"	This parameter can be accessible from 2.0 version. It will generate token against the given card details.
"pp_TxnType"	Presents the transaction type: MPAY – Direct Pay Mode AUTH – Authorize/Capture Mode
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_TxnDateTime"	Merchant provided date and time of transaction. The format of date time should be yyyyMMddHHmmss.
"pp_TxnExpiryDateTime"	Transaction Expiry can be specified by merchant to indicate to the issuing bank that the transaction must be approved within this period. Please note that the default and maximum value of this expiry is 3 months.
"pp_BillReference"	Bill/invoice Number being settled.
"pp_Description"	Transaction details to be shown on screen as desired by the merchant. This field will be parsed to identify any malicious data entered by the end user. In cases when any of these characters <>\*=%/:'\|"{} are inserted, they will be replaced with a space.
"pp_TokenizedCardNumber"	It represents the token for returning customer against their already saved card.
"pp_UsageMode"	Represent the usage mode that is API:Initiate Authentication With Token From API PR:Initiate Authentication With Token From PR (Page Redirection Or Landing Page)
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter	Description
"responseCode"	Success / Failure Response code.
"responseMessage"	Response message receive in case of success and failure.
"authenticationStatus"	If user is egligible for authentication or not.
"status"	Status receive in case of success and failure.
"gatewayRecommendation"	Gateway Recommedation represent if customer can proceed or not.
"secureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Authenticate Payer

Request to authenticate a payer, i.e. verify the identity of a cardholder.

Request Body

{ "pp_Version": "2.0", "pp_TxnType": "MPAY", "pp_TxnRefNo": "T20221127183304", "pp_MerchantID": "RafayKhan7", "pp_Password": "0123456789", "pp_Amount": "20000", "pp_3DS2ReturnURL": "http://localhost/MerchantSimulator/merchant/testview", "pp_browser": "MOZILLA", "pp_3DSecureChallengeWindowSize": "FULL_SCREEN", "pp_acceptHeaders": "application/json", "pp_colorDepth": "24", "pp_javaEnabled": true, "pp_language": "en-US", "pp_screenHeight": "640", "pp_screenWidth": "480", "pp_timeZone": "273", "pp_CustomerCardNumber": "5123456789012346", "pp_CustomerCardExpiry": "12/22", "pp_CustomerCardCvv": "123", "pp_SecureHash": "", "pp_UsageMode": "API", "pp_IsRegisteredCustomer" : "Yes", "pp_ShouldTokenizeCardNumber" : "Yes", "pp_JavaScriptEnabled": "true" }

Response Body

{ "responseCode": "000", "responseMessage": "Thank you for Using JazzCash, your transaction was successful.", "authenticationStatus": "AUTHENTICATION_SUCCESSFUL", "status": "SUCCESS", "gatewayRecommendation": "PROCEED", "html": " <div id=\"threedsFrictionLessRedirect\" xmlns=\"http://www.w3.org/1999/html\"> <iframe id=\"challengeFrame\" name=\"challengeFrame\"> </iframe> <form id=\"threedsFrictionLessRedirectForm\" method=\"POST\" action=\"http://localhost/MerchantSimulator/merchant/testview\" target=\"challengeFrame\"> <input type=\"hidden\" name=\"order.id\" value=\"RAFAYKHAN7T20221127183304\" /> <input type=\"hidden\" name=\"transaction.id\" value=\"221127664007\" /> <input type=\"hidden\" name=\"response.gatewayRecommendation\" value=\"PROCEED\" /> <input type=\"hidden\" name=\"result\" value=\"SUCCESS\" /> </form> <script id=\"authenticate-payer-script\"> var e = document.getElementById(\"threedsFrictionLessRedirectForm\"); if (e) { e.submit(); if (e.parentNode !== null) { e.parentNode.removeChild(e); } } </script> </div>", "secureHash": "" }

Parameter Description

Input Parameters

Parameter	Description
"pp_Version"	API Version. Fixed value ‘1.1’ or ‘2.0’ should be used.
"pp_TxnType"	Presents the transaction type: MPAY – Direct Pay Mode AUTH – Authorize/Capture Mode
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_MerchantID"	Unique code assigned to each Merchant by PG.
"pp_Password"	Password assigned to each merchant and is used to authenticate merchant at the time of payment. Password is a system generated value.
"pp_Amount	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_3DS2ReturnURL"	Merchant return URL after OTP verification.
"pp_browser"	The User-Agent header of the browser the customer used to place the order
"pp_3DSecureChallengeWindowSize"	Dimensions of the challenge window (in width x height in pixels) displayed to the payer during 3D-Secure authentication.
"pp_acceptHeaders"	The content of the Accept request-header field as sent from the payer's browser.
"pp_colorDepth"	The bit depth (in bits per pixel) of the color palette for displaying images.
"pp_javaEnabled"	Indicates whether or not the payer's browser supports Java.
"pp_language"	The language supported for the payer's browser.
"pp_screenHeight"	The total height of the payer's browser screen in pixels.
"pp_screenWidth"	The total width of the payer's browser screen in pixels.
"pp_timeZone"	Time difference between UTC time and the Cardholder browser local time, in minutes.
"pp_CustomerCardNumber"	Card number of the customer making the payment. It should be of maximum 16 numeric digits.
"pp_CustomerCardExpiry"	Expiry date of the card used for making payment. Format: MMYY (Month Month Year Year).
"pp_CustomerCardCvv"	Card verification value, as printed on the back or front of the card.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_UsageMode"	Authenticate Payer via API or PR
"pp_IsRegisteredCustomer"	It represents that the request has been made by the registered or a guest customer of a merchant.
"pp_ShouldTokenizeCardNumber"	This parameter can be accessible from 2.0 version. It represents that the request should have tokenize card number.
"pp_JavaScriptEnabled"	Indicates whether or not the payer's browser supports JavaScript

Output Parameters

Parameter	Description
"responseCode"	Success / Failure Response code
"responseMessage"	Response message receive in case of success and failure.
"authenticationStatus"	AUTHENTICATION_AVAILABLE
"status"	SUCCESS
"gatewayRecommendation"	PROCEED
"secureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Authenticate Payer Via Token

This request is made to interpret the authentication response returned from the card Issuer's Access Control Server (ACS) after the cardholder completes the authentication process using token. The response indicates the success or otherwise of the authentication.This request is specific for returning customer transaction.

Request Body

{ "pp_Version": "2.0", "pp_TxnType": "MPAY", "pp_TxnRefNo": "T20221127192933", "pp_MerchantID": "RafayKhan7", "pp_Password": "0123456789", "pp_Amount": "20000", "pp_3DS2ReturnURL": "http://localhost/MerchantSimulator/merchant/testview", "pp_browser": "MOZILLA", "pp_3DSecureChallengeWindowSize": "FULL_SCREEN", "pp_acceptHeaders": "application/json", "pp_colorDepth": "24", "pp_javaEnabled": true, "pp_language": "en-US", "pp_screenHeight": "640", "pp_screenWidth": "480", "pp_timeZone": "273", "pp_SecureHash": "", "pp_UsageMode": "API", "pp_IsRegisteredCustomer" : "Yes", "pp_ShouldTokenizeCardNumber" : "Yes", "pp_JavaScriptEnabled": "true", "pp_TokenizedCardNumber":"9228924639592086" }

Response Body

{ "responseCode": "000", "responseMessage": "Thank you for Using JazzCash, your transaction was successful.", "authenticationStatus": "AUTHENTICATION_SUCCESSFUL", "status": "SUCCESS", "gatewayRecommendation": "PROCEED", "html":" <div id=\"threedsFrictionLessRedirect\" xmlns=\"http://www.w3.org/1999/html\"> <iframe id=\"challengeFrame\" name=\"challengeFrame\"> </iframe> <form id=\"threedsFrictionLessRedirectForm\" method=\"POST\" action=\"http://localhost/MerchantSimulator/merchant/testview\" target=\"challengeFrame\"> <input type=\"hidden\" name=\"order.id\" value=\"RAFAYKHAN7T20221127192933\" /> <input type=\"hidden\" name=\"transaction.id\" value=\"221127664012\" /> <input type=\"hidden\" name=\"response.gatewayRecommendation\" value=\"PROCEED\" /> <input type=\"hidden\" name=\"result\" value=\"SUCCESS\" /> </form> <script id=\"authenticate-payer-script\"> var e = document.getElementById(\"threedsFrictionLessRedirectForm\"); if (e) { e.submit(); if (e.parentNode !== null) { e.parentNode.removeChild(e); } } </script> </div> ", "secureHash": "" }

Parameter Description

Input Parameters

Parameter	Description
"pp_Version"	API Version. Fixed value ‘1.1’ or ‘2.0’ should be used
"pp_TxnType"	Presents the transaction type: MPAY – Direct Pay Mode AUTH – Authorize/Capture Mode
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_MerchantID"	Unique code assigned to each Merchant by PG.
"pp_Password"	Password assigned to each merchant and is used to authenticate merchant at the time of payment. Password is a system generated value.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_3DS2ReturnURL"	Merchant return URL after OTP verification.
"pp_browser"	The User-Agent header of the browser the customer used to place the order
"pp_acceptHeaders"	The content of the Accept request-header field as sent from the payer's browser.
"pp_colorDepth"	The bit depth (in bits per pixel) of the color palette for displaying images.
"pp_javaEnabled"	Indicates whether or not the payer's browser supports Java
"pp_language"	The language supported for the payer's browser
"pp_screenHeight"	The total height of the payer's browser screen in pixels.
"pp_screenWidth"	The total width of the payer's browser screen in pixels.
"pp_timeZone"	Time difference between UTC time and the Cardholder browser local time, in minutes.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_UsageMode"	API OR PR
"pp_IsRegisteredCustomer"	It represents that the request has been made by the registered or a guest customer of a merchant.
"pp_ShouldTokenizeCardNumber"	This parameter can be accessible from 2.0 version. It represents that the request should have tokenize card number.
"pp_JavaScriptEnabled"	Indicates whether or not the payer's browser supports JavaScript
"pp_TokenizedCardNumber"	It represents the token for returning customer against their already saved card.

Output Parameters

Parameter	Description
"responseCode"	Success / Failure Response code
"responseMessage"	Response message receive in case of success and failure.
"authenticationStatus"	AUTHENTICATION_AVAILABLE
"status"	SUCCESS
"gatewayRecommendation"	PROCEED
"secureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Direct Pay

This is a single transaction to authorize payment and transfer funds from payer's account to merchant’s account.

Request Body

Response Body

Parameter Description

Input Parameters

Parameter Description

"pp_IsRegisteredCustomer" It represents that the request has been made by the registered or a guest customer of a merchant.

"pp_ShouldTokenizeCardNumber" Its value represents of the customer has requested to save the card details. If its value is yes, then a token will be generated against the CHD and will be sent to merchant via ITN

"pp_CustomerID" Registered Customer’s LoginID or Identifier provided by Merchant.

"pp_CustomerEmail" Registered Customer’s email address provided by Merchant.

"pp_CustomerMobile" Registered Customer’s mobile no. provided by Merchant.

"pp_Version" API Version. Fixed value ‘1.1’ or ‘2.0’ should be used

"pp_TxnType" For this transaction, it will be fixed value “MPAY”

"pp_TxnRefNo" A unique value created by the merchant to identify the transaction.

"pp_MerchantID" Unique merchant code assigned to each Merchant by PG.

"pp_Password" Password assigned to each merchant and is used to authenticate merchant at the time of payment. Password is a system generated value.

"pp_Amount" The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.

"pp_TxnCurrency" Currency of Transaction amount. It has a fixed value ‘PKR’.

"pp_TxnDateTime" Merchant provided date and time of transaction. The format of date time should be yyyyMMddHHmmss.

"pp_TxnExpiryDateTime" Transaction Expiry can be specified by merchant to indicate to the issuing bank that the transaction must be approved within this period. Please note that the default and maximum value of this expiry is 3 months.

"pp_BillReference" Bill/invoice Number being settled.

"pp_Description" Transaction details to be shown on screen as desired by the merchant. This field will be parsed to identify any malicious data entered by the end user. In cases when any of these characters <>\*=%/:'|"{} are inserted, they will be replaced with a space.

"pp_CustomerCardNumber" Card number of the customer making the payment.

"pp_CustomerCardCvv" Card verification value, as printed on the back or front of the card.

"pp_CustomerCardExpiry" Expiry date of the card used for making payment. Format: MMYY (Month Month Year Year).

"pp_SecureHash" Used to allow the Payment Gateway to check the integrity of the transaction request.

"pp_DiscountedAmount" The discounted amount merchant wants to send. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.

"pp_DiscountBank" BankID of the bank for which merchant wish to send discount..

"pp_UsageMode" API OR PR

Output Parameters

Parameter Description

"responseCode" Response code representing the transaction success or failure. A response code of 000 represents success.

"responseMessage" Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.

"status" SUCCESS

"pp_RetreivalReferenceNo" RRN Retreival Reference Number

"secureHash" Used to allow the Payment Gateway to check the integrity of the transaction request.

Direct Pay via Token

This is a single transaction to authorize payment and transfer funds from payer's account to merchant’s account using Token against customer's already saved card.This request is specific for returning customer transaction.

Request Body

{ "pp_IsRegisteredCustomer": "Yes", "pp_ShouldTokenizeCardNumber": "Yes", "pp_CustomerID":"testPay", "pp_CustomerEmail":"test@test.com", "pp_CustomerMobile":"033456789025", "pp_TxnType": "MPAY", "pp_TxnRefNo": "T20190403093759", "pp_MerchantID": "Merc0003", "pp_Password": "0123456789", "pp_Amount": "20000", "pp_TxnCurrency": "PKR", "pp_TxnDateTime": "20190403093750", "pp_TxnExpiryDateTime": "20190403093747", "pp_BillReference": "billRef", "pp_Description": "Description of pay transaction", "pp_TokenizedCardNumber":"9790662127634170", "pp_CustomerCardCvv": "123", "pp_SecureHash": "1B7082A29290BF222194C0CEF052D08F7E16", "pp_Version": "2.0" }

Response Body

{ "responseCode": "000", "responseMessage": "Thank you for Using JazzCash, your transaction was successful.", "status": "SUCCESS", "pp_RetreivalReferenceNo": "221211678054", "secureHash": "" }

Parameter Description

Input Parameters

Parameter	Description
"pp_IsRegisteredCustomer"	It represents that the request has been made by the registered or a guest customer of a merchant.
"pp_ShouldTokenizeCardNumber"	Its value represents of the customer has requested to save the card details. If its value is yes, then a token will be generated against the CHD and will be sent to merchant via ITN
"pp_CustomerID"	Registered Customer’s LoginID or Identifier provided by Merchant.
"pp_CustomerEmail"	Registered Customer’s email address provided by Merchant.
"pp_CustomerMobile"	Registered Customer’s mobile no. provided by Merchant.
"pp_TxnType"	For this transaction, it will be fixed value “MPAY”
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_MerchantID"	Unique merchant code assigned to each Merchant by PG.
"pp_Password"	Password assigned to each merchant and is used to authenticate merchant at the time of payment. Password is a system generated value.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of Transaction amount. It has a fixed value ‘PKR’.
"pp_TxnDateTime"	Merchant provided date and time of transaction. The format of date time should be yyyyMMddHHmmss.
"pp_TxnExpiryDateTime"	Transaction Expiry can be specified by merchant to indicate to the issuing bank that the transaction must be approved within this period. Please note that the default and maximum value of this expiry is 3 months.
"pp_BillReference"	Bill/invoice Number being settled.
"pp_Description"	Transaction details to be shown on screen as desired by the merchant. This field will be parsed to identify any malicious data entered by the end user. In cases when any of these characters <>\*=%/:'"{} are inserted, they will be replaced with a space. Pipe ‘\|’ is not allowed
"pp_TokenizedCardNumber"	It represents the tokenized card number of returning customer. This token will be received to the merchant in response of Pay request when saved card details was selected by the customer on Payment portal.
"pp_CustomerCardCvv"	Customer Card CVV mentioned on back of card
"pp_SecureHash"	Checksum to check the integrity of the transaction request by PG
"pp_Version"	API Version. Fixed value ‘1.1’ or ‘2.0’ should be used

Output Parameters

Parameter	Description
"responseCode"	Response code representing the transaction success or failure. A response code of 000 represents success.
"responseMessage"	Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.
"status"	SUCCESS
"pp_RetreivalReferenceNo"	RRN Retreival Reference Number
"secureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Authorize

This is a request to obtain an authorization for a proposed funds transfer. An authorization is a response from a financial institution indicating that payment information is valid and funds are available in the payer's account.

Request Body

{ "pp_InstrumentType": "CARD", "pp_Frequency": "SINGLE", "pp_TxnRefNo": "T20190620102046", "pp_Amount": "1000", "pp_TxnCurrency": "PKR", "pp_CustomerCardNumber": "5123456789012346", "pp_CustomerCardExpiry": "0120", "pp_CustomerCardCvv": "111", "pp_MerchantID": "Test00127801", "pp_Password": "0123456789", "pp_CustomerID": "test", "pp_CustomerEmail": "test@test.com", "pp_CustomerMobile": "03222852628", "pp_IsRegisteredCustomer": "Yes", "pp_ShouldTokenizeCardNumber": "No", "pp_3DSecureID": "20190620102712564329", "pp_SecureHash": "" }

Response Body

{ "pp_InstrToken": "F0C774F759EAB8E71ADDD7A4241A3330352F566961EB3B317F8E96D1C18DDA24", "pp_TokenizationResponseCode": "", "pp_TokenizationResponseMessage": "", "pp_CustomerCardNumber": "5123456789012346", "pp_CustomerCardExpiry": "0120", "pp_CustomerID": "test", "pp_CustomerEmail": "test@test.com", "pp_CustomerMobile": "03222852628", "pp_ShouldTokenizeCardNumber": "No", "pp_IsRegisteredCustomer": "Yes", "pp_TxnRefNo": "T20190620102046", "pp_MerchantID": "Test00127801", "pp_Password": "0123456789", "pp_Amount": "1000", "pp_TxnCurrency": "PKR", "pp_InstrumentType": "CARD", "pp_Frequency": "SINGLE", "pp_3DSecureID": "20190620102712564329", "pp_SecureHash": "", "pp_ResponseCode": "000", "pp_ResponseMessage": "Thank you for Using JazzCash, your transaction was successful. " }

Parameter Description

Input Parameters

Parameter	Description
"pp_InstrumentType"	Type of instrument used for making payment.
"pp_Frequency"	Indicates the frequency of the transaction offered to the payer. Value could be any one of the following, based on the usage: SINGLE: Indicates a single transaction where a single payment is used to complete the order. RECURRING: Indicates a recurring transaction where the payer authorizes you to automatically debit their accounts for bill or invoice payments.
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_CustomerCardNumber"	Card number of the customer making the payment.
"pp_CustomerCardExpiry"	Expiry date of the card used for making payment. Format: MMYY (Month Month Year Year).
"pp_CustomerCardCvv"	Card verification value, as printed on the back or front of the card.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_CustomerID"	Registered Customer’s LoginID or Identifier address provided by Merchant.
"pp_CustomerEmail"	Registered Customer’s Email address provided by Merchant.
"pp_CustomerMobile"	Regsitered Customer’s Mobile Number provided by Merchant.
"pp_IsRegisteredCustomer"	Yes, if user is already registered. No, if customer is not.
"pp_ShouldTokenizeCardNumber"	It represents the request for Create token against provided customer card details,inorder to avoid entering complete card information for future use.
"pp_3dSecureID"	A unique identifier supplied by Jazz Cash to Merchant in Check 3DS Enrollment response.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter	Description
"pp_InstrToken"
"pp_TokenizationResponseCode"	Response code representing whether token generated successfully or not. A response code of T01 represents success.
"pp_TokenizationResponseMessage"	Error details in case the token failed to be processed. This field will be mandatory for all cases where response code is not equal to T01.
"pp_CustomerCardNumber"	Card number of the customer making the payment.
"pp_CustomerCardExpiry"	Expiry date of the card used for making payment. Format: MMYY (Month Month Year Year).
"pp_CustomerID"	Customer’s LoginID or Identifier address provided by Merchant.
"pp_CustomerEmail"	Customer’s Email address provided by Merchant.
"pp_CustomerMobile"	Customer’s Mobile Number provided by Merchant.
"pp_ShouldTokenizeCardNumber"	It represents the request for Create token against provided customer card details,inorder to avoid entering complete card information for future use.
"pp_IsRegisteredCustomer"	Yes, if user is already registered. No, if customer is not.
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_InstrumentType"	Type of instrument used for making payment.
"pp_Frequency"	Indicates the frequency of the transaction offered to the payer. Value could be any one of the following, based on the usage: SINGLE: Indicates a single transaction where a single payment is used to complete the order. RECURRING: Indicates a recurring transaction where the payer authorizes you to automatically debit their accounts for bill or invoice payments.
"pp_3dSecureID"	A unique identifier supplied by Jazz Cash to Merchant in Check 3DS Enrollment response.
"pp_SecureHash"	Used to allow the Merchant to check the integrity of the transaction response.
"pp_ResponseCode"	Response code representing the transaction success or failure. A response code of 000 represents success.
"pp_ResponseMessage"	Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.

Authorize Via Token

Request Body

{ "pp_InstrumentType":"CARD", "pp_Frequency" : "SINGLE", "pp_IsRegisteredCustomer" : "Yes", "pp_TxnRefNo":"T20190614173948", "pp_Amount":"10000", "pp_TxnCurrency":"PKR", "pp_TokenizedCardNumber": "9580698967588146", "pp_MerchantID":"Test00127801", "pp_Password":"0123456789", "pp_CustomerID":"test", "pp_CustomerEmail":"test@test.com", "pp_CustomerMobile":"03222852628", "pp_3DSecureID": "", "pp_SecureHash":"" }

Response Body

{ "pp_IsRegisteredCustomer": "Yes", "pp_TxnRefNo": "T20190620170650", "pp_MerchantID": "Test00127801", "pp_Password": "0123456789", "pp_Amount": "10000", "pp_TxnCurrency": "PKR", "pp_InstrumentType": "CARD", "pp_Frequency": "SINGLE", "pp_3DSecureID": "", "pp_InstrToken": "", "pp_CustomerID": "test", "pp_CustomerEmail": "test@test.com", "pp_CustomerMobile": "03222852628", "pp_TokenizedCardNumber": "9580698967588146", "pp_SecureHash": "EB35B67EBCBF17238F63E165543520E31AAFF1F9763662BA4FEFA00EBA8D90E9", "pp_ResponseCode": "000", "pp_ResponseMessage": "Thank you for Using JazzCash, your transaction was successful. " }

Parameter Description

Input Parameters

Parameter	Description
"pp_InstrumentType"	Type of instrument used for making payment.
"pp_Frequency"	Indicates the frequency of the transaction offered to the payer. Value could be any one of the following, based on the usage: SINGLE: Indicates a single transaction where a single payment is used to complete the order. RECURRING: Indicates a recurring transaction where the payer authorizes you to automatically debit their accounts for bill or invoice payments.
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_CustomerCardNumber"	Card number of the customer making the payment.
"pp_CustomerCardExpiry"	Expiry date of the card used for making payment. Format: MMYY (Month Month Year Year).
"pp_CustomerCardCvv"	Card verification value, as printed on the back or front of the card.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_Frequency"	Indicates the frequency of the transaction offered to the payer. Value could be any one of the following, based on the usage: SINGLE: Indicates a single transaction where a single payment is used to complete the order. RECURRING: Indicates a recurring transaction where the payer authorizes you to automatically debit their accounts for bill or invoice payments.

Output Parameters

Parameter	Description
"pp_IsRegisteredCustomer"	Yes, if user is already registered. No, if customer is not.
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_InstrumentType"	Type of instrument used for making payment.
"pp_Frequency"	Indicates the frequency of the transaction offered to the payer. Value could be any one of the following, based on the usage: SINGLE: Indicates a single transaction where a single payment is used to complete the order. RECURRING: Indicates a recurring transaction where the payer authorizes you to automatically debit their accounts for bill or invoice payments.
"pp_3dSecureID"	A unique identifier supplied by Jazz Cash to Merchant in Check 3DS Enrollment response.
"pp_InstrToken"
"pp_CustomerID"	Customer’s LoginID or Identifier address provided by Merchant.
"pp_CustomerEmail"	Customer’s Email address provided by Merchant.
"pp_CustomerMobile"	Customer’s Mobile Number provided by Merchant.
"pp_TokenizedCardNumber"	It represents the token for returning customer against their already saved card.
"pp_SecureHash"	Used to allow the merchant to check the integrity of the transaction response.
"pp_ResponseCode"	Response code representing the transaction success or failure. A response code of 000 represents success.
"pp_ResponseMessage"	Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.

Capture

This is a request to capture funds previously reserved by an authorization. A Capture transaction triggers the movement of funds from the payer's account to the merchant's account.

Request Body

{ "pp_TxnRefNo": "T20190620102046", "pp_Amount":"1000", "pp_TxnCurrency":"PKR", "pp_MerchantID": "Test00127801", "pp_Password": "0123456789", "pp_3DSecureID": "20190620102712564329", "pp_SecureHash":"" }

Response Body

{ "pp_TxnRefNo": "T20190620102046", "pp_MerchantID": "Test00127801", "pp_Password": "0123456789", "pp_Amount": "1000", "pp_TxnCurrency": "PKR", "pp_3DSecureID": "20190620102712564329", "pp_SecureHash": "", "pp_ResponseCode": "000", "pp_ResponseMessage": "Thank you for Using JazzCash, your transaction was successful. " }

Parameter Description

Input Parameters

Parameter	Description
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter	Description
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_3dSecureID"	A unique identifier supplied by Jazz Cash to Merchant in Check 3DS Enrollment response.
"pp_SecureHash"	Used to allow the Merchant to check the integrity of the transaction response.
"pp_ResponseCode"	Response code representing the transaction success or failure. A response code of 000 represents success.
"pp_ResponseMessage"	Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.

Retrieve

This is a request to retrieve the details of an order and all transactions associated with this order.

Request Body

{ "pp_TxnRefNo":"T20170518161115", "pp_MerchantID":"Test00127801", "pp_Password":"0123456789", "pp_SecureHash":"", "pp_Version":"2.0" }

Response Body

{ "status": "", "rrn": "", "settlementDate": "", "settlementExpiryDate": "", "authCode": "", "bankID": "", "productID": "" }

Parameter Description

Input Parameters

Parameter	Description
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_Version"	Payment Portal Version. Fixed value ‘1.1’ should be used.

Output Parameters

Parameter	Description
"status"	Status of the transaction at JazzCash payment gateway.
"rrn"	A unique number generated by the Payment Gateway at the time of transaction processing. The number should be stored and used for future reference. The number is unique for any given date.
"settlementDate"	A date supplied by the Payment Gateway to indicate when this transaction will be settled. When the Payment Gateway closes the batch at the end of the day, the date will roll over to the next processing day’s date. This date will only be provided in case a transaction is already confirmed by the merchant.
"settlementExpiryDate"	A date supplied by the Payment Gateway indicating that if the merchant does not send a confirmation of the transaction by this time, the payment gateway will mark the transaction as expired and the merchant will not be able to resume it. This field will be mandatory where Auth Code is available.
"authCode"	An identifying code issued by the issuing bank to approve or deny the transaction. The field is mandatory in case of successful response code. Refer to Appendix I for a list of response codes and the codes which when sent will require Auth Code.
"bankID"	This field will only be used in case of Direct Debit transaction type, otherwise it should be sent as an empty field. Customer’s bank that authorized the transaction.
"productID"	This field will only be used in case of Direct Debit transaction type. Product ID of bank through which payment has been performed. e.g. Retail, Corporate. Fixed values: ‘RETL’, ‘CORP’. In case value was provided at the time of request, this field will contain the same value. Otherwise, ID of the product chosen by customer at Payment Gateway will be filled.

Mobile Account API's

Following API’s are available with detailed description and relevant information for Mobile Account.

REST based Mobile Account API - Version 1.1 - Default

This is REST based API used for the transaction of Mobile Account as a payment instrument.

Request Body

{ "pp_Language": "EN", "pp_MerchantID": "RafayKhan7", "pp_SubMerchantID": "", "pp_Password": "0123456789", "pp_TxnRefNo": "", "pp_MobileNumber":"03411728699", "pp_CNIC": "345678", "pp_Amount": "10000", "pp_DiscountedAmount":"", "pp_TxnCurrency": "PKR", "pp_TxnDateTime": "", "pp_BillReference": "", "pp_Description": "", "pp_TxnExpiryDateTime",: "", "pp_SecureHash": "", "ppmpf_1" : "", "ppmpf_2" : "", "ppmpf_3" : "", "ppmpf_4" : "", "ppmpf_5" : "" }

Response Body

{ "pp_Amount": "10000", "pp_AuthCode": "", "pp_BillReference": "billRef", "pp_Language": "EN", "pp_MerchantID": "RafayKhan7", "pp_ResponseCode": "000", "pp_ResponseMessage": "Thank you for Using JazzCash, your transaction was successful.", "pp_RetrievalReferenceNo": "", "pp_SubMerchantID": "", "pp_TxnCurrency": "PKR", "pp_TxnDateTime": "", "pp_TxnRefNo": "", "pp_MobileNumber": "03123456789", "pp_CNIC": "345678", "pp_DiscountedAmount": "", "ppmpf_1": "", "ppmpf_2": "", "ppmpf_3": "", "ppmpf_4": "", "ppmpf_5": "", "pp_SecureHash": "" }

Parameter Description

Input Parameters

Parameter	Description
"pp_Version"	Payment Portal Version. Fixed value ‘1.1’ should be used.
"pp_TxnType"	Type of instrument used for making payment.
"pp_Language"	Specifies the language in which to display the page. Fixed value ‘EN’.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_SubMerchantID"	Unique Id assigned to each sub merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_MobileNumber"	MobileNumber for MWallet Account.
"pp_CNIC"	Last 6 digits of CNIC number for MWallet Account.
"pp_DiscountedAmount"	Discounted Amount (Final amount after discount).
"pp_TxnDateTime"	Merchant provided date and time of transaction. The format of date time should be yyyyMMddHHmmss.
"pp_BillReference"	Bill/invoice Number being settled.
"pp_Description"	Transaction details to be shown on screen as desired by the merchant. This field will be parsed to identify any malicious data entered by the end user. In cases when any of these characters <>\*=%/:'\|"{} are inserted, they will be replaced with a space.
"pp_TxnExpiryDateTime"	Transaction Expiry can be specified by merchant to indicate to the issuing bank that the transaction must be approved within this period. Please note that the default and maximum value of this expiry is 3 months.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter	Description
"responseCode"	Response code representing the transaction success or failure. A response code of 000 represents success.
"responseMessage"	Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.

SOAP based Mobile Account API - Version 1.1 - Default

This is SOAP based API used for the transaction of Mobile Account as a payment instrument.

Request Body

{ "pp_Language": "EN", "pp_MerchantID": "RafayKhan7", "pp_SubMerchantID": "", "pp_Password": "0123456789", "pp_TxnRefNo": "T20171017133843", "pp_MobileNumber":"03411728699", "pp_Amount": "100", "pp_Version": "1.1", "pp_TxnType": "MWALLET", "pp_BankID": "" "pp_ProductID": "" "pp_TxnCurrency": "PKR", "pp_TxnDateTime": "20171017133843", "pp_BillReference": "billRef", "pp_Description": "Descp", "pp_TxnExpiryDateTime": "20171024133843", "pp_SecureHash": "", "ppmpf_1" : "03122036440", "ppmpf_2" : "", "ppmpf_3" : "", "ppmpf_4" : "", "ppmpf_5" : "" }

Response Body

{ "pp_Amount": "100", "pp_AuthCode": "", "pp_BillReference": "billRef", "pp_Language": "EN", "pp_MerchantID": "RafayKhan7", "pp_ResponseCode": "000", "pp_Amount": "100", "pp_ResponseMessage": "Transaction completed.", "pp_SubMerchantID": "", "pp_TxnCurrency": "PKR", "pp_TxnType": "MWALLET", "pp_TxnDateTime": "20171017133843", "pp_TxnRefNo": "T20171017133843", "pp_MobileNumber": "03123456789", "pp_TxnExpiryDateTime": "20171024133843", "pp_DiscountedAmount": "0", "pp_SecureHash": "" "ppmpf_1": "", "ppmpf_2": "", "ppmpf_3": "", "ppmpf_4": "", "ppmpf_5": "", }

Parameter Description

Input Parameters

Parameter	Description
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_TxnType"	Type of instrument used for making payment.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_TxnDateTime"	Merchant provided date and time of transaction. The format of date time should be yyyyMMddHHmmss.
"pp_TxnExpiryDateTime"	Transaction Expiry can be specified by merchant to indicate to the issuing bank that the transaction must be approved within this period. Please note that the default and maximum value of this expiry is 3 months.
"pp_BillReference"	Bill/invoice Number being settled.
"pp_Description"	Transaction details to be shown on screen as desired by the merchant. This field will be parsed to identify any malicious data entered by the end user. In cases when any of these characters <>\*=%/:'\|"{} are inserted, they will be replaced with a space.
"pp_CustomerCardNumber"	Card number of the customer making the payment.
"pp_CustomerCardExpiry"	Expiry date of the card used for making payment. Format: MMYY (Month Month Year Year).
"pp_CustomerCardCvv"	Card verification value, as printed on the back or front of the card.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_Version"	Payment Portal Version. Fixed value ‘1.1’ should be used.
"pp_Frequency"	Indicates the frequency of the transaction offered to the payer. Value could be any one of the following, based on the usage: SINGLE: Indicates a single transaction where a single payment is used to complete the order. RECURRING: Indicates a recurring transaction where the payer authorizes you to automatically debit their accounts for bill or invoice payments.

Output Parameters

Parameter	Description
"responseCode"	Response code representing the transaction success or failure. A response code of 000 represents success.
"responseMessage"	Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.

REST based Mobile Account API - Version 2.0 - CNIC Enablement
This is REST based API used for the transaction of Mobile Account as a payment instrument.

Request Body

Response Body

Parameter Description

Input Parameters

Parameter Description

"pp_TxnRefNo" A unique value created by the merchant to identify the transaction.

"pp_TxnType" Type of instrument used for making payment.

"pp_Amount" The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.

"pp_TxnCurrency" Currency of transaction amount. It has a fixed value ‘PKR’.

"pp_TxnDateTime" Merchant provided date and time of transaction. The format of date time should be yyyyMMddHHmmss.

"pp_TxnExpiryDateTime" Transaction Expiry can be specified by merchant to indicate to the issuing bank that the transaction must be approved within this period. Please note that the default and maximum value of this expiry is 3 months.

"pp_BillReference" Bill/invoice Number being settled.

"pp_Description" Transaction details to be shown on screen as desired by the merchant. This field will be parsed to identify any malicious data entered by the end user. In cases when any of these characters <>\*=%/:'|"{} are inserted, they will be replaced with a space.

"pp_MerchantID" Unique Id assigned to each merchant by the payment gateway.

"pp_Password" Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.

"pp_SecureHash" Used to allow the Payment Gateway to check the integrity of the transaction request.

"pp_Version" Payment Portal Version. Fixed value ‘1.1’ should be used.

"pp_CNIC" This field will contain Customer’s last 6 digits of CNIC (used only in version 2.0)

Output Parameters

Parameter Description

"responseCode" Response code representing the transaction success or failure. A response code of 000 represents success.

"responseMessage" Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.

REST based Mobile Account API - Version 3.0 - Hosted MPIN
This is REST based API used for the transaction of Mobile Account as a payment instrument.

Request Body

Response Body

Parameter Description

Input Parameters

Parameter Description

"pp_TxnRefNo" A unique value created by the merchant to identify the transaction.

"pp_UsageMode" Specifies the usage mode of API calling.

"pp_DiscountedAmount" The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.

"pp_Amount" This field will contain final amount after discount (used only in version 2.0)

"pp_TxnCurrency" Currency of transaction amount. It has a fixed value ‘PKR’.

"pp_TxnDateTime" Merchant provided date and time of transaction. The format of date time should be yyyyMMddHHmmss.

"pp_TxnExpiryDateTime" Transaction Expiry can be specified by merchant to indicate to the issuing bank that the transaction must be approved within this period. Please note that the default and maximum value of this expiry is 3 months.

"pp_BillReference" Bill/invoice Number being settled.

"pp_Description" Transaction details to be shown on screen as desired by the merchant. This field will be parsed to identify any malicious data entered by the end user. In cases when any of these characters <>\*=%/:'|"{} are inserted, they will be replaced with a space.

"pp_MerchantID" Unique Id assigned to each merchant by the payment gateway.

"pp_SubMerchantID" If the merchant is handling any child merchants at its end, then the child merchant Id will be provided. The Transaction reports will be grouped on the basis of Sub Merchant Id, if available.

"pp_MobileNumber" This field will contain Customer’s Mobile Number (used only in version 2.0)

"pp_Password" Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.

"pp_SecureHash" Used to allow the Payment Gateway to check the integrity of the transaction request.

"pp_Version" Payment Portal Version. Fixed value ‘1.1’ should be used.

"pp_CNIC" This field will contain Customer’s last 6 digits of CNIC (used only in version 2.0)

"pp_MPIN" This field will contain Customer’s 4 digit MPIN

Output Parameters

Parameter Description

"pp_ResponseCode" Response code representing the transaction success or failure. A response code of 000 represents success.

"pp_ResponseMessage" Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.

"pp_MerchantID" Unique Id assigned to each merchant by the payment gateway.

"pp_SubMerchantID" If the merchant is handling any child merchants at its end, then the child merchant Id will be provided. The Transaction reports will be grouped on the basis of Sub Merchant Id, if available.

"pp_Amount" This field will contain final amount after discount (used only in version 2.0)

"pp_TxnDateTime" Merchant provided date and time of transaction. The format of date time should be yyyyMMddHHmmss.

"pp_RetrievalReferenceNo" A unique number generated by the Payment Gateway when the transaction got processed. The number should be stored and used for future reference. The number is unique for any given date.

"pp_AuthCode" An identifying code issued by the issuing bank to approve or deny the transaction. The field is mandatory in case of successful response code. Refer to Appendix I for a list of response

"pp_TxnRefNo" A unique value created by the merchant to identify the transaction.

"pp_MobileNumber" This field will contain Customer’s Mobile Number (used only in version 2.0)

"pp_DiscountedAmount" The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.

"pp_SecureHash" Used to allow the Payment Gateway to check the integrity of the transaction request.

REST based Mobile Account Linking API - Version 4.0 - Recurring Payments
This is REST based API used for the transaction of Mobile Account as a payment instrument.

Request Body

Response Body

Parameter Description

Input Parameters

Parameter Description

"pp_RequestID" A unique value created by the merchant to identify the request.

"pp_MerchantID" Unique Id assigned to each merchant by the payment gateway.

"pp_Password" Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.

"pp_MobileNumber" This field will contain Customer’s Mobile Number (used only in version 2.0)

"pp_CNIC" This field will contain Customer’s last 6 digits of CNIC (used only in version 2.0)

"pp_MPIN" This field will contain Customer’s 4 digit MPIN

"pp_SecureHash" Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter Description

"pp_ResponseCode" Response code representing the transaction success or failure. A response code of 000 represents success.

"pp_ResponseMessage" Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.

"pp_Token" Unique Token value for requested mobile account.

"pp_SecureHash" Used to allow the Payment Gateway to check the integrity of the transaction request.

REST based Mobile Account API - Version 4.0 - Recurring Payments
This is REST based API used for the transaction of Mobile Account as a payment instrument.

Request Body

Response Body

Parameter Description

Input Parameters

Parameter Description

"pp_PaymentToken" Unique Token value for mobile account transaction.

"pp_TxnRefNo" A unique value created by the merchant to identify the transaction.

"pp_Amount" This field will contain final amount after discount (used only in version 2.0)

"pp_MerchantID" Unique Id assigned to each merchant by the payment gateway.

"pp_Password" Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.

"pp_BillReference" Bill/invoice Number being settled.

"pp_Description" Transaction details to be shown on screen as desired by the merchant. This field will be parsed to identify any malicious data entered by the end user. In cases when any of these characters <>\*=%/:'|"{} are inserted, they will be replaced with a space.

"pp_TxnCurrency" Currency of transaction amount. It has a fixed value ‘PKR’.

"pp_TxnDateTime" Merchant provided date and time of transaction. The format of date time should be yyyyMMddHHmmss.

"pp_TxnExpiryDateTime" Transaction Expiry can be specified by merchant to indicate to the issuing bank that the transaction must be approved within this period. Please note that the default and maximum value of this expiry is 3 months.

"pp_DiscountedAmount" The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.

"pp_ppmpf#" These are optional fields, if sent, will be part of the secure hash.

"pp_SecureHash" Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter Description

"pp_ResponseCode" Response code representing the transaction success or failure. A response code of 000 represents success.

"pp_ResponseMessage" Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.

"pp_Amount" This field will contain final amount after discount (used only in version 2.0)

"pp_RetrievalReferenceNo" A unique number generated by the Payment Gateway when the transaction got processed. The number should be stored and used for future reference. The number is unique for any given date.

"pp_TxnRefNo" A unique value created by the merchant to identify the transaction.

"pp_PaymentToken" Unique Token value for mobile account transaction.

"pp_DiscountedAmount" The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.

"pp_SecureHash" Used to allow the Payment Gateway to check the integrity of the transaction request.

Voucher API's

Following API’s are available with detailed description and relevant information for Voucher Payment.

REST based Voucher Payment API

This is REST based API used for the transaction of Voucher as payment instrument.

Request Body

{ "pp_Version":"1.1", "pp_TxnType":"OTC", "pp_Language":"EN", "pp_MerchantID":"Test00127801", "pp_SubMerchantID":"", "pp_Password":"0123456789", "pp_BankID":"", "pp_ProductID":"", "pp_TxnRefNo":"T20170517101549", "pp_Amount":"100", "pp_TxnCurrency":"PKR", "pp_TxnDateTime":"20170517101549", "pp_BillReference":"billRef", "pp_Description":"Description", "pp_TxnExpiryDateTime":"20170824101549", "pp_ReturnURL":"http://localhost/MerchantSimulator/HttpRequestDemoServer/Index", "pp_SecureHash":"", "ppmpf_1":"03122036440", "ppmpf_2":"", "ppmpf_3":"", "ppmpf_4":"", "ppmpf_5":"" }

Response Body

{ "pp_Amount": "", "pp_AuthCode": "", "pp_BankID": "", "pp_BillReference": "", "pp_Language": "", "pp_MerchantID": "", "pp_ResponseCode": "", "pp_ResponseMessage": "", "pp_RetreivalReferenceNo": "", "pp_SubMerchantId": "", "pp_TxnCurrency": "", "pp_TxnDateTime": "", "pp_TxnRefNo": "", "pp_SettlementExpiry": "", "pp_TxnType": "", "pp_Version": "", "ppmbf_1": "", "ppmbf_2": "", "ppmbf_3": "", "ppmbf_4": "", "ppmbf_5": "", "ppmpf_1": "", "ppmpf_2": "", "ppmpf_3": "", "ppmpf_4": "", "ppmpf_5": "", "pp_SecureHash": "" }

Parameter Description

Input Parameters

Parameter	Description
"pp_Version"	Payment Portal Version. Fixed value ‘1.1’ should be used.
"pp_TxnType"	Type of instrument used for making payment.
"pp_Language"	Specifies the language in which to display the page. Fixed value ‘EN’.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_SubMerchantID"	Unique Id assigned to each sub merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_TxnDateTime"	Merchant provided date and time of transaction. The format of date time should be yyyyMMddHHmmss.
"pp_BillReference"	Bill/invoice Number being settled.
"pp_Description"	Transaction details to be shown on screen as desired by the merchant. This field will be parsed to identify any malicious data entered by the end user. In cases when any of these characters <>\*=%/:'\|"{} are inserted, they will be replaced with a space.
"pp_TxnExpiryDateTime"	Transaction Expiry can be specified by merchant to indicate to the issuing bank that the transaction must be approved within this period. Please note that the default and maximum value of this expiry is 3 months.
"pp_ReturnURL"	The URL where merchant wants the transaction results to be shown. Once the transaction has been processed, response details will be sent over to the merchant on this URL using an HTTP POST Request.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter	Description
"responseCode"	Response code representing the transaction success or failure. A response code of 000 represents success.
"responseMessage"	Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.

SOAP based Voucher API

This is soap based API used for the transaction of Voucher as payment instrument.

Request Body

{ "pp_Language": "EN", "pp_MerchantID": "RafayKhan7", "pp_SubMerchantID": "", "pp_Password": "0123456789", "pp_TxnRefNo": "T20171017133843", "pp_TxnType": "OTC", "pp_MobileNumber":"03411728699", "pp_Version": "1.1", "pp_BankID": "", "pp_ProductID": "", "pp_Amount": "100", "pp_TxnCurrency": "PKR", "pp_TxnDateTime": "20171017133843", "pp_BillReference": "billRef", "pp_Description": "Descp", "pp_TxnExpiryDateTime",: "20171024133843", "pp_SecureHash": "", "ppmpf_1" : "03122036440", "ppmpf_2" : "", "ppmpf_3" : "", "ppmpf_4" : "", "ppmpf_5" : "" }

Response Body

{ "pp_Amount": "100", "pp_AuthCode": "", "pp_BillReference": "billRef", "pp_Language": "EN", "pp_MerchantID": "RafayKhan7", "pp_ResponseCode": "124", "pp_Amount": "100", "pp_ResponseMessage": "Order is placed and waiting for financials to be received over the counter.", "pp_SubMerchantID": "", "pp_TxnCurrency": "PKR", "pp_TxnType": "OTC", "pp_TxnDateTime": "20171017133843", "pp_TxnRefNo": "T20171017133843", "pp_MobileNumber": "03122036440", "pp_TxnExpiryDateTime": "20171017007938", "pp_DiscountedAmount": "0", "pp_SecureHash": "" "ppmpf_1": "", "ppmpf_2": "", "ppmpf_3": "", "ppmpf_4": "", "ppmpf_5": "", }

Parameter Description

Input Parameters

Parameter	Description
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_TxnType"	Type of instrument used for making payment.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_TxnDateTime"	Merchant provided date and time of transaction. The format of date time should be yyyyMMddHHmmss.
"pp_TxnExpiryDateTime"	Transaction Expiry can be specified by merchant to indicate to the issuing bank that the transaction must be approved within this period. Please note that the default and maximum value of this expiry is 3 months.
"pp_BillReference"	Bill/invoice Number being settled.
"pp_Description"	Transaction details to be shown on screen as desired by the merchant. This field will be parsed to identify any malicious data entered by the end user. In cases when any of these characters <>\*=%/:'\|"{} are inserted, they will be replaced with a space.
"pp_CustomerCardNumber"	Card number of the customer making the payment.
"pp_CustomerCardExpiry"	Expiry date of the card used for making payment. Format: MMYY (Month Month Year Year).
"pp_CustomerCardCvv"	Card verification value, as printed on the back or front of the card.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_Version"	Payment Portal Version. Fixed value ‘1.1’ should be used.
"pp_Frequency"	Indicates the frequency of the transaction offered to the payer. Value could be any one of the following, based on the usage: SINGLE: Indicates a single transaction where a single payment is used to complete the order. RECURRING: Indicates a recurring transaction where the payer authorizes you to automatically debit their accounts for bill or invoice payments.

Output Parameters

Parameter	Description
"responseCode"	Response code representing the transaction success or failure. A response code of 000 represents success.
"responseMessage"	Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.

REST based Expire Voucher API

This API is used to expire the given voucher on merchant’s consent

Request Body

{ "pp_MerchantID" : "RafayKhan7", "pp_Password" : "0123456789", "pp_Voucher" : "210331232548", "pp_SecureHash" : "7AC1F74C9FEBFDBAB1BCABC4B5E19A6DAEE5A7BE2AD067FE0C729B44061AC9FC" }

Response Body

{ "pp_ResponseCode": "000", "pp_ResponseMessage": "The requested operation has been performed successfully.", "pp_Voucher": "210406238600", "pp_SecureHash": "0E8803FDD5C918F31C8ED3171EE8C12C26E6903ED20FC459103E56525FB514E9" }

Parameter Description

Input Parameters

Parameter	Description
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Voucher"	A unique value created by the merchant to identify the voucher.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter	Description
"pp_responseCode"	Response code representing the transaction success or failure. A response code of 000 represents success.
"pp_responseMessage"	Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.
"pp_Voucher"	A unique value created by the merchant to identify the voucher.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Bank Account API's

Following API’s are available with detailed description and relevant information for Bank Account Payment.

REST based Bank Account Validate Customer API

This is REST based API used to validate customer for the transaction of Bank Account as payment instrument.

Request Body

{ "pp_MerchantID":"RafayKhan7", "pp_SubMerchantID":"", "pp_Password":"0123456789", "pp_BankID":"11", "pp_TxnRefNo":"T20220217103423", "pp_Amount":"10000", "pp_CNIC":"4210112345678", "pp_AccountNo":"PKSCB4352345234523452345", "pp_MobileNumber":"03412817399", "pp_EmailAddress":"emailemail@gmail.com", "pp_TxnDateTime":"20220217103423", "pp_SecureHash":"a94e1cf4e0ad9d2e9c6987531db52eb508f0d1d9576b499469b16dd41b8bf894" }

Response Body

{ "pp_ResponseCode":"000", "pp_ResponseMessage":"Thank you for Using JazzCash, your operation successfully completed.", "pp_TxnRefNo":"T20220217103423", "pp_SecureHash":"946A3CDE52B733A96CCAA0FB1A3AF8A83F787EC229F73D7551378F2EE1F29276" }

Parameter Description

Input Parameters

Parameter	Description
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_SubMerchantID"	Unique Id assigned to each sub merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_BankID"	Bank ID provided by merchant to perform transaction through provided bank.
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_CNIC"	This field will contain Customer’s CNIC.
"pp_AccountNo"	This field will contain Bank account number of customer.
"pp_MobileNumber"	This field will contain Customer’s Mobile Number.
"pp_EmailAddress"	This field will contain Customer’s email address.
"pp_TxnDateTime"	Merchant provided date and time of transaction. The format of date time should be yyyyMMddHHmmss.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter	Description
"pp_ResponseCode"	Response code representing the transaction success or failure. A response code of 000 represents success.
"pp_ResponseMessage"	Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

REST based Bank Account Payment API

This is REST based API used for the transaction of Bank Account as payment instrument.

Request Body

{ "pp_MerchantID":"RafayKhan7", "pp_Password":"0123456789", "pp_TxnRefNo":"T20220216140731", "pp_OTP":"123456", "pp_BillReference":"bill Ref", "pp_Currency":"PKR", "pp_Description":"Description", "ppmpf_1":"1", "ppmpf_2":"2", "ppmpf_3":"3", "ppmpf_4":"4", "ppmpf_5":"5", "pp_SecureHash":"128376a8f0317d1768cf94b2d38bee8754b418dc6d6910f8e9c06124f1114c54" }

Response Body

{ "pp_ResponseCode":"000", "pp_ResponseMessage":"Thank you for Using JazzCash, your transaction was successful.", "pp_TxnRefNo":"T20220216140731", "pp_SecureHash":"145067841BC9A8C65D9E00C2C78AD2894672CA266D215992F307C2ADA58FB3AE" }

Parameter Description

Input Parameters

Parameter	Description
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_OTP"	Value of OTP received by customer to perform Bank Account Transaction.
"pp_BillReference"	Bill/invoice Number being settled.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_Description"	Transaction details to be shown on screen as desired by the merchant. This field will be parsed to identify any malicious data entered by the end user. In cases when any of these characters <>\*=%/:'\|"{} are inserted, they will be replaced with a space.
"ppmpf_#"	Optional value provided by merchant to maintain their record.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter	Description
"pp_ResponseCode"	Response code representing the transaction success or failure. A response code of 000 represents success.
"pp_ResponseMessage"	Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

REST based Bank Account Get Banks API

This is REST based API used to fetch list of avaiable banks to perform bank account transaction

Request Body

{ "pp_MerchantID":"RafayKhan7", "pp_Password":"0123456789", "pp_SecureHash":"a94e1cf4e0ad9d2e9c6987531db52eb508f0d1d9576b499469b16dd41b8bf894" }

Response Body

{ "pp_ResponseCode":"000", "pp_ResponseMessage":"The requested operation has been performed successfully.", "pp_Banks":[ { "BankCode":"28", "BankName":"Al Baraka" }, { "BankCode":"24", "BankName":"Bank Alfalah" }, { "BankCode":"11", "BankName":"Demo Bank" } ] }

Parameter Description

Input Parameters

Parameter	Description
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter	Description
"pp_ResponseCode"	Response code representing the transaction success or failure. A response code of 000 represents success.
"pp_ResponseMessage"	Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.
"pp_Banks"	This field will contains list of Banks with BankCode and BankName.

Retrieve Token

This is a request to retrieve the card details based on given token, which was previously provided to the user while user was asked to save their card details during performing the card transaction.

Retrieve Token Request JSON:

{ "pp_Language": "EN", "pp_CorrelationId": "", "pp_IsRegisteredCustomer": "Yes", "pp_MerchantID": "MC0484", "pp_Password": "89tfat7e74", "pp_InstrumentType": "CARD", "pp_TokenizedCardNumber": "", "pp_SecureHash": "" }

Retrieve Token Response JSON:

{ "pp_Brand": "MASTERCARD", "pp_Expiry": "1225", "pp_FundingMethod": "DEBIT", "pp_Issuer": "BANCO DEL PICHINCHA, C.A.", "pp_LocalBrand": "MASTERCARD", "pp_cardNumber": "512345******2346", "pp_tokenStatus": "VALID", "pp_Language": "EN", "pp_MerchantID": "MC0484", "pp_SecureHash": "", "pp_Password": "89tfat7e74", "pp_InstrumentType": "CARD", "pp_TokenizedCardNumber": "9580698967588146", "pp_CorrelationId": "20190503175517", "pp_IsRegisteredCustomer": "Yes", "pp_ResponseCode": "T00", "pp_ResponseMessage": "The tokenization operation was successfully processed" }

Parameter Description

Input Parameters

Parameter	Description
"pp_Language"	Language Code used by .
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_InstrumentType"	Type of instrument used for making payment.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_TokenizedCardNumber"	A number provided by payment gateway to reuse card details which was saved against this number.
"pp_IsRegisteredCustomer"	Yes, if user is already registered. No, if customer is not.

Output Parameters

Parameter	Description
"pp_Brand"	Type/Brand of user’s card.
"pp_Expiry"	Expiry date of the card used for making payment. Format: MMYY (Month Month Year Year).
"pp_FundingMethod"	Method through which card funds will be transferred.
"pp_Issuer"	Issuer of user’s card.
"pp_LocalBrand"	Type/Brand of user’s card.
"pp_cardNumber"	Card number of the customer.
"pp_tokenStatus"	Status of token, which was given by user in request.
"pp_Language"	Language code.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_InstrumentType"	Type of instrument used for making payment.
"pp_TokenizedCardNumber"	card number on the basis of which token was provided to user.
"pp_CorrelationId"	Unique Identifier.
"pp_IsRegisteredCustomer"	Whether the customer was previously registered or not.
"pp_ResponseCode"	Response code representing the operation success or failure. A response code of T00 represents success.
"pp_ResponseMessage"	Error details in case the operation failed to be processed. This field will be mandatory for all cases where response code is not equal to T00.

Delete Token

This is a request to delete the card details based on given token which was previously provided to the user while user was asked to save their card details during performing the card transaction.

Delete Token Request JSON:

{ "pp_Language": "EN", "pp_CorrelationId": "20190503175740", "pp_IsRegisteredCustomer": "Yes", "pp_MerchantID": "MC0484", "pp_Password": "89tfat7e74", "pp_InstrumentType": "CARD", "pp_TokenizedCardNumber": "9580698967588146", "pp_SecureHash": "d0dfd405bdd1724877d976d31c06cbef7282e2319b47d4cc9602daee44139a09" }

Delete Token Response JSON:

{ "pp_Language": "EN", "pp_MerchantID": "MC0484", "pp_SecureHash": "", "pp_Password": "89tfat7e74", "pp_InstrumentType": "CARD", "pp_TokenizedCardNumber": "9580698967588146", "pp_CorrelationId": "20190503175817", "pp_IsRegisteredCustomer": "Yes", "pp_ResponseCode": "T00", "pp_ResponseMessage": "The tokenization operation was successfully processed" }

Parameter Description

Input Parameters

Parameter	Description
"pp_Language"	Language Code
"pp_CorrelationId"	Unique Identifier.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_InstrumentType"	Type of instrument used for making payment.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_TokenizedCardNumber"	card number on the basis of which token was provided to user
"pp_IsRegisteredCustomer"	Whether the customer was previously registered or not

Output Parameters

Parameter	Description
"pp_Language"	Language Code.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_InstrumentType"	Type of instrument used for making payment.
"pp_TokenizedCardNumber"	Card number on the basis of which token was provided to user.
"pp_CorrelationId"	Unique Identifier.
"pp_IsRegisteredCustomer"	Whether the customer was previously registered or not.
"pp_ResponseCode"	Response code representing the operation success or failure. A response code of T00 represents success.
"pp_ResponseMessage"	Error details in case the operation failed to be processed. This field will be mandatory for all cases where response code is not equal to T00.

Inquire Token

This is a request to fetch the token based on the given transaction reference number. The fetched token is the one which was previously provided to the user while user was asked to save their card details during performing the card transaction of the provided Transaction reference number.

Inquire Token Request JSON:

{ "pp_Language": "EN", "pp_TxnRefNo": "T20191129130351", "pp_MerchantId": "MC0484", "pp_Password": "89tfat7e74", "pp_SecureHash": "" }

Inquire Token Response JSON:

{ "pp_Token": "9580698967588146", "pp_SecureHash": "", "pp_ResponseCode": "T00", "pp_ResponseMessage": "The tokenization operation was successfully processed" }

Parameter Description

Input Parameters

Parameter	Description
"pp_Language"	Language Code
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter	Description
"pp_Token"	A number provided by payment gateway to reuse card details which was saved against this number.
"pp_ResponseCode"	Response code representing the operation success or failure. A response code of T00 represents success.
"pp_ResponseMessage"	Error details in case the operation failed to be processed. This field will be mandatory for all cases where response code is not equal to T00.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Update Token

This request will update expiry of saved token against the provided field of TokenizedCardNumber.

Update Token Request JSON:

{ "pp_Language": "EN", "pp_CorrelationId": "abcosiufgjss18", "pp_IsRegisteredCustomer": "Yes", "pp_MerchantID": "TestMerchant", "pp_Password": "0123456789", "pp_InstrumentType": "CARD", "pp_TokenizedCardNumber": "5123458791130008", "pp_CustomerCardExpiry": "1225", "pp_SecureHash": "" }

Update Token Response JSON:

{ "pp_Expiry": "1225", "pp_cardNumber": "512345xxxxxx0008", "pp_tokenStatus": "VALID", "pp_Language": "EN", "pp_MerchantID": "TestMerchant ", "pp_SecureHash": "", "pp_Password": "0123456789", "pp_InstrumentType": "CARD", "pp_TokenizedCardNumber": "5123458791130008", "pp_CorrelationId": "abcosiufgjss18", "pp_IsRegisteredCustomer": "Yes", "pp_ResponseCode": "T00", "pp_ResponseMessage": "The tokenization operation was successfully processed" }

Parameter Description

Input Parameters

Parameter	Description
"pp_Language"	Specifies the language in which to display the page. Fixed value ‘EN’.
"pp_CorrelationId"	It’s a Unique Identifier. It can be alphanumeric and should not be greater than 40
"pp_MerchantID"	Unique Merchant Code assigned to each Merchant by PG.
"pp_Password"	Password assigned to each merchant and is used to authenticate merchant at the time of payment. It is a system generated value.
"pp_SecureHash"	Checksum to check the integrity of the transaction request, by Payment Gateway.

Output Parameters

Parameter	Description
"pp_Expiry"	Expiry date of card in the format of MM/YY.
"pp_cardNumber"	Masked Card number of the customer who made the payment.
"pp_tokenStatus"	Validity status of the provided token.
"pp_Language"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_MerchantID"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_Password"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_InstrumentType"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_TokenizedCardNumber"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_CorrelationId"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_IsRegisteredCustomer"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_ResponseCode"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_ResponseMessage"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Refund API's

Following refund based API’s are available with detailed description and relevant information.

Rest Based Mobile Account Refund API

This is a request for refund transaction of mobile account.

Request Body

{ "pp_TxnRefNo":"T20190515094840", "pp_Amount":"20000", "pp_TxnCurrency": "PKR", "pp_MerchantID": "MC2645", "pp_Password": "vgyttef556", "pp_MerchantMPIN": "1111", "pp_SecureHash": "70524E8D609D14F2D9DF6DB4887A36EA0D4A247B0EB4B3E85730FCD4D9C74503" }

Response Body

{ "pp_SecureHash": "", "pp_ResponseCode": "000", "pp_ResponseMessage": "Thank you for Using JazzCash, your transaction was successful." } Authorize

Parameter Description

Input Parameters

Parameter	Description
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_MerchantMPIN"	4 digit numeric MPIN of JazzCash mobile Accounty.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter	Description
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"responseCode"	Response code representing the transaction success or failure. A response code of 000 represents success.
"responseMessage"	Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.

Rest Based Card Refund API

This is a request for refund transaction of direct pay.

Request Body

{ "pp_TxnRefNo": "T20201204151517", "pp_Amount": "10000", "pp_TxnCurrency": "PKR", "pp_MerchantID": "MC2645", "pp_Password": "vgyttef556", "pp_SecureHash": "F1CB6FE2F69A5B86C63B49F309AC37BBC40FE6A5394CED7147C6876820F6A1AF" }

Response Body

{ "pp_SecureHash": "", "pp_ResponseCode": "000", "pp_ResponseMessage": "Thank you for Using JazzCash, your transaction was successful." } Authorize

Parameter Description

Input Parameters

Parameter	Description
"pp_TxnRefNo"	A unique value created by the merchant to identify the transaction.
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter	Description
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"responseCode"	Response code representing the transaction success or failure. A response code of 000 represents success.
"responseMessage"	Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.

Rest Based Voucher Refund API

This is a request for refund transaction of Voucher.

Request Body

{ "pp_VoucherID": "210401236561", "pp_MerchantID": "RafayKhan7", "pp_Password": "0123456789", "pp_CNIC":"4201234567890", "pp_Currency":"PKR", "pp_Amount":"10000", "pp_SecureHash" : "7AC1F74C9FEBFDBAB1BCABC4B5E19A6DAEE5A7BE2AD067FE0C729B44061AC9FC" }

Response Body

{ "pp_ResponseCode": "000", "pp_ResponseMessage": "The requested operation has been performed successfully.", "pp_SecureHash": "0E8803FDD5C918F31C8ED3171EE8C12C26E6903ED20FC459103E56525FB514E9" }

Parameter Description

Input Parameters

Parameter	Description
"pp_VoucherID"	A unique value created by the merchant to identify the voucher.
"pp_CNIC"	This field will contain Customer’s last 6 digits of CNIC (used only in version 2.0)
"pp_Amount"	The transaction amount. Please note that no decimal places are included. Decimal place will be assumed at the default position of the currency provided.
"pp_TxnCurrency"	Currency of transaction amount. It has a fixed value ‘PKR’.
"pp_MerchantID"	Unique Id assigned to each merchant by the payment gateway.
"pp_Password"	Assigned to each merchant, used for authentication of the merchant at the time of payment. Password is a system generated value.
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.

Output Parameters

Parameter	Description
"pp_SecureHash"	Used to allow the Payment Gateway to check the integrity of the transaction request.
"pp_responseCode"	Response code representing the transaction success or failure. A response code of 000 represents success.
"pp_responseMessage"	Error details in case the transaction failed to be processed. This field will be mandatory for all cases where response code is not equal to 000.