Pakistan API

Before reading this API documentation, please make sure to check API Description Guide

Transaction Limits

Transaction Type	Limit (Unit: PKR)
Collection	10-500000
Disbursement	10-100000

Collection API

Collection Application

Brief Description:

Create a collection order

URL: /pkr/collect/apply
Note: appId needs to use PKR corresponding, user payment success will increase PKR balance Parameters:

Parameter	Required	Type	Description
appId	Yes	Long	Business ID (obtained from the backend, must pass the corresponding business ID according to the currency in URL)
orderId	Yes	String	Merchant Order Number (must be unique, max length: 48)
name	Yes	String	Recipient’s Name
phone	Yes	String	Mobile number
email	Yes	String	Real Email
amount	Yes	String	Transaction Amount
payType	Yes	String	Transaction Type
inBankCode	Yes	String	Payment Method
callBackUrl	Yes	String	Redirect URL after successful payment
callBackFailUrl	Yes	String	Redirect URL after failed payment
notifyUrl	No	String	Callback URL
subject	No	String	Payment Note
body	No	String	Note Details
idCard	No	String	ID card number, required for JAZZCASH
partnerUserId	Yes	String	Unique user identifier (e.g., userId), used for risk control system, must be valid, otherwise it will affect the transaction. Format: digits, letters, or symbols -~!@#$%&*()_.
sign	Yes	String	Signature

Return Data Parameters

Parameter	Type	Description
orderId	String	Merchant Order Number (must be unique)
orderNo	String	Platform Order Number
payUrl	String	Payment URL
qrCode	String	QR Code content – can generate QR by yourself
sign	String	Signature

Collection Query

Brief Description:

Query collection order

URL: /pkr/collect/query Parameters:

Parameter	Required	Type	Description
appId	Yes	Long	Business ID (obtained from the backend, must pass the corresponding business ID according to the currency in URL)
orderId	Yes	String	Merchant Order Number
orderNo	No	String	Platform Order Number (faster response)
sign	Yes	String	Signature

Return Data Parameters

Parameter	Type	Description
orderId	String	Merchant Order Number (must be unique)
orderNo	String	Platform Order Number
amount	String	Transaction Amount
actualAmount	String	Received Amount
fee	String	Fee
status	Integer	Status (0 Not Started, 1 Processing, 2 Success [final], 3 Failed [final], -1 Pending Confirmation)
payTime	String	Payment Success Time (present when status=2) (Pakistan Time), format: yyyy-MM-dd HH:mm:ss
errorMsg	String	Failure Reason (present when status=3)
sign	String	Signature

Payment Methods

Currency	Payment Type (payType)	Payment Code (inBankCode)	Limit	Status	Description
PKR	PAYMENT_GATEWAY	CASHIER	10-500000	Available	Cashier Mode
PKR	EWALLET	JAZZCASH	10-500000	Available	JazzCash Wallet
PKR	EWALLET	EASYPAISA	10-500000	Available	EasyPaisa Wallet
PKR	EWALLET	ALFA	10-500000	Maintenance	ALFA Wallet
PKR	EWALLET	HBL_KONNECT	10-500000	Maintenance	HBL KONNECT Wallet

Disbursement API

Disbursement Apply

Brief Description:

Create a disbursement order

URL: /pkr/pay/apply Parameters:

Parameter	Required	Type	Description
appId	Yes	Long	Business ID (obtained from the backend, must pass the corresponding business ID according to the currency in URL)
orderId	Yes	String	Merchant Order Number (must be unique, max length 48)
amount	Yes	String	Transaction Amount (accurate to two decimals; no punctuation allowed, e.g., “,” is forbidden)
accountType	Yes	String	Account Type: EWALLET (E-wallet), BANK_ACCOUNT (Bank)
bankCode	Yes	String	Payment Code
accountNo	Yes	String	User’s bank account number or wallet account number
name	Yes	String	Recipient’s Name
phone	Yes	String	Real Mobile Number
email	Yes	String	Real Email
notifyUrl	No	String	Callback URL
subject	Yes	String	Payment Note (transaction title, product name, reason for payment)
body	No	String	Note Details
birth	Yes	String	Date of Birth, format: yyyy-MM-dd
gender	Yes	String	Gender, allowed values: MALE, FEMALE, or OTHER
idCard	No	String	ID card number
partnerUserId	Yes	String	Unique user identifier (e.g., userId), used for risk control system, must be valid, otherwise it will affect the transaction. Format: digits, letters, or symbols -~!@#$%&*()_.
sign	Yes	String	Signature

Return Data Parameters

Parameter	Required	Type
orderId	String	Merchant Order Number (must be unique)
orderNo	String	Platform Order Number
sign	String	Signature

Disbursement Query

Brief Description:

Query disbursement order

URL: /pkr/pay/query Parameters:

Parameter	Required	Type	Description
appId	Yes	Long	Business ID (obtained from the backend, must pass the corresponding business ID according to the currency in URL)
orderId	Yes	String	Merchant Order Number
orderNo	No	String	Platform Order Number (faster response)
sign	Yes	String	Signature

Return Data Parameters

Parameter	Type	Description
orderId	String	Merchant Order Number (must be unique)
orderNo	String	Platform Order Number
amount	String	Transaction Amount
fee	String	Fee
status	Integer	Status (0 Not Started, 1 Processing, 2 Success [final], 3 Failed [final], -1 Pending Confirmation)
payTime	String	Payment Success Time (present when status=2) (Pakistan Time), format: yyyy-MM-dd HH:mm:ss
errorMsg	String	Failure Reason (present when status=3)
sign	String	Signature

Payment Codes

Currency	Payment Type (accountType)	Payment Code (bankCode)	Limit	Status	Description
PKR	EWALLET	ALFA	10-100000	Available	ALFA Wallet
PKR	EWALLET	BAFL	10-100000	Available	Bank Alfalah Limited
PKR	EWALLET	EASYPAISA	10-100000	Available	EasyPaisa Wallet
PKR	EWALLET	JAZZCASH	10-100000	Available	JazzCash Wallet
PKR	EWALLET	HBL_KONNECT	10-100000	Available	HBL KONNECT Wallet
PKR	BANK_ACCOUNT	ABBL	10-100000	Available	Al Baraka Bank Limited
PKR	BANK_ACCOUNT	ABHI	10-100000	Available	Abhi Finance
PKR	BANK_ACCOUNT	ABL	10-100000	Available	Allied Bank Limited
PKR	BANK_ACCOUNT	ACBL	10-100000	Available	Askari Commercial Bank
PKR	BANK_ACCOUNT	ADVANS	10-100000	Available	Advans Pakistan
PKR	BANK_ACCOUNT	APNA	10-100000	Available	Apna Microfinance Bank
PKR	BANK_ACCOUNT	BAHL	10-100000	Available	Bank AL Habib Limited
PKR	BANK_ACCOUNT	BARWAQT	10-100000	Available	Barwaqt
PKR	BANK_ACCOUNT	BIPL	10-100000	Available	BankIslami Pakistan
PKR	BANK_ACCOUNT	BOK	10-100000	Available	Bank of Khyber
PKR	BANK_ACCOUNT	BOP	10-100000	Available	Bank of Punjab
PKR	BANK_ACCOUNT	BYKEA	10-100000	Available	BYKEA
PKR	BANK_ACCOUNT	CDNS	10-100000	Available	CDNS
PKR	BANK_ACCOUNT	CITI	10-100000	Available	Citi Bank
PKR	BANK_ACCOUNT	DIBPL	10-100000	Available	Dubai Islamic Bank
PKR	BANK_ACCOUNT	FAYSAL	10-100000	Available	Faysal Bank Limited
PKR	BANK_ACCOUNT	FINCA	10-100000	Available	FINCA Microfinance Bank
PKR	BANK_ACCOUNT	FINJA	10-100000	Available	FINJA EMI
PKR	BANK_ACCOUNT	FMB	10-100000	Available	First Microfinance Bank
PKR	BANK_ACCOUNT	FWBL	10-100000	Available	First Women Bank Limited
PKR	BANK_ACCOUNT	HBL	10-100000	Available	Habib Bank Limited
PKR	BANK_ACCOUNT	HBLASSET	10-100000	Available	HBL ASSET MANAGEMENT
PKR	BANK_ACCOUNT	HMBL	10-100000	Available	Habib Metropolitan Bank
PKR	BANK_ACCOUNT	ICBC	10-100000	Available	ICBC
PKR	BANK_ACCOUNT	JSB	10-100000	Available	JS Bank
PKR	BANK_ACCOUNT	KHUSHALI	10-100000	Available	Khushali Bank
PKR	BANK_ACCOUNT	MCB	10-100000	Available	MCB Bank Limited
PKR	BANK_ACCOUNT	MCBARIF	10-100000	Available	MCB ARIF HABIB
PKR	BANK_ACCOUNT	MCIB	10-100000	Available	MCB Islamic Banking
PKR	BANK_ACCOUNT	MEEZAN	10-100000	Available	Meezan Bank Limited
PKR	BANK_ACCOUNT	MOD	10-100000	Available	MOD
PKR	BANK_ACCOUNT	NAYAPAY	10-100000	Available	NayaPay Private Limited
PKR	BANK_ACCOUNT	NBP	10-100000	Available	National Bank of Pakistan
PKR	BANK_ACCOUNT	NBPF	10-100000	Available	NBP Funds
PKR	BANK_ACCOUNT	NRSP	10-100000	Available	NRSP Microfinance
PKR	BANK_ACCOUNT	PAYMAX	10-100000	Available	PayMax (Zong)
PKR	BANK_ACCOUNT	SADAPAY	10-100000	Available	SadaPay
PKR	BANK_ACCOUNT	SAMBA	10-100000	Available	SAMBA
PKR	BANK_ACCOUNT	SCB	10-100000	Available	Standard Chartered Bank
PKR	BANK_ACCOUNT	SILK	10-100000	Available	Silk Bank
PKR	BANK_ACCOUNT	SIMPAISA	10-100000	Available	SimPaisa
PKR	BANK_ACCOUNT	SINDH	10-100000	Available	Sindh Bank
PKR	BANK_ACCOUNT	SME	10-100000	Available	SME Bank Limited
PKR	BANK_ACCOUNT	SONERI	10-100000	Available	Soneri Bank Limited
PKR	BANK_ACCOUNT	SUMMIT	10-100000	Available	Summit Bank
PKR	BANK_ACCOUNT	UBANK	10-100000	Available	Ubank
PKR	BANK_ACCOUNT	UBL	10-100000	Available	United Bank Limited
PKR	BANK_ACCOUNT	WHITE	10-100000	Available	WHITE LABEL ATM
PKR	BANK_ACCOUNT	ZARAI	10-100000	Available	Zarai Taraqiati Bank

Quick start

Merchant Guide

Common Payment

Global Payment

Unified API

End To End Testing

Appendix

Merchant FAQ

Transaction Limits

Collection API

Collection Application

Collection Query

Payment Methods

Disbursement API

Disbursement Apply

Disbursement Query

Payment Codes

Quick start

Merchant Guide

Common Payment

Global Payment

Unified API

End To End Testing

Appendix

Merchant FAQ

​Transaction Limits

​Collection API

​Collection Application

​Collection Query

​Payment Methods

​Disbursement API

​Disbursement Apply

​Disbursement Query

​Payment Codes

Transaction Limits

Collection API

Collection Application

Collection Query

Payment Methods

Disbursement API

Disbursement Apply

Disbursement Query

Payment Codes