Warning

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

Limits

Transaction Type	Limit (Unit: PKR)
Collection	Mainly depends on the user's account
Disbursement	10-100000

Collection API

Collection Apply

Brief Description:

• Create a collection order

URL: /pkr/collect/apply
Note: appId in PKR, amount in PKR, settlement also in PKR

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	Real mobile number. In non-cashier mode, a real mobile number is required to receive OTP for payment. Must start with 3 and be 10 digits long.
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 HBL_KONNECT and JAZZCASH
partnerUserId	Yes	String	Unique User Identifier (e.g., userId). Required for risk control, must be valid. Allowed format: numbers, uppercase/lowercase letters, or common 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

payType	inBankcode	Description
PAYMENT_GATEWAY	CASHIER	Cashier Mode
EWALLET	ALFA	ALFA Wallet
EWALLET	HBL_KONNECT	HBL KONNECT Wallet
EWALLET	JAZZCASH	JAZZCASH Wallet
EWALLET	EASYPAISA	EASYPAISA 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, required for JAZZCASH
partnerUserId	Yes	String	Unique User Identifier (e.g., userId). Required for risk control, must be valid. Allowed format: numbers, uppercase/lowercase letters, or common symbols -~!@#$%&*()_.
sign	Yes	String	Signature

Return Data Parameters

Parameter	Required	Type	Description
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

Bank Codes

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

Wallet Codes

bankCode	bankName
ALFA	ALFA Wallet
BAFL	Bank Alfalah Limited
EASYPAISA	Telenor Microfinance Bank
JAZZCASH	Mobilink Microfinance
HBL_KONNECT	HBL Konnect Wallet