← Back to HBL Pay Payment Gateway overview
Quick Start — HBL Pay Payment Gateway
Enterprise HBL Pay payment gateway integration for Perfex CRM
5-minute Quick Start
Follow this short path the first time you use HBL Pay Payment Gateway:
- Activate — Setup → Modules → activate HBL Pay Payment Gateway (run Upgrade if prompted).
- Permissions — Setup → Staff → Roles → enable view/create/edit (and approve/settings if needed) for this module.
- Settings — Open HBL Pay Payment Gateway → Settings and save company defaults, prefixes, and integrations.
- Master data — Create the first required masters (products, warehouses, templates, channels, accounts, routes, etc.).
- First transaction — Create one sample record end-to-end (save → submit/approve → complete) and confirm it appears in lists/reports.
- Cron — If the module uses alerts, sync, queues, or AI, confirm Perfex CRM cron is scheduled on the server.
Full how-to guide (from module package)
The steps below come from the module author's printable guide — follow them in order for best results.
HOW TO USE — HBL Pay Payment Gateway for Perfex CRM
Author: Nasbix Technologies | Version: 1.0.0
═══════════════════════════════════════════════════════
1. INSTALLATION
═══════════════════════════════════════════════════════
- Extract the main ZIP (Main File).
2. Upload the folder "hblpay_gateway" into:
/your-perfex-root/modules/
- Login as admin → Setup → Modules.
- Click Activate on "HBL Pay Payment Gateway".
- Database tables + email templates + options are created automatically.
6. Assign staff permissions: Setup → Staff → Roles
(View HBL Transactions, Manage HBL Settings, Export HBL Reports).
7. Configure gateway:
Setup → Settings → Payment Gateways → HBL Pay
═══════════════════════════════════════════════════════
2. GATEWAY CONFIGURATION (required)
═══════════════════════════════════════════════════════
Enter from your HBL Pay merchant portal:
• Merchant ID
• Store ID
• API Username
• API Password
• Secret Key
• HBL Public Key (RSA PEM) — if required by your HBL setup
• Merchant Private Key (RSA PEM) — if required by your HBL setup
Then:
• Enable Testing Mode for sandbox OR Live Mode for production
• Optional: override Success URL / Failed URL
• Optional: confirm Sandbox / Production API & Portal URLs
• Copy Callback URL, Success URL, Failed URL
into the HBL Pay merchant portal
• Set gateway Active = Yes
Note: The module will not activate until Merchant ID, Store ID,
API credentials, and Secret Key are configured.
═══════════════════════════════════════════════════════
3. HOW CLIENTS PAY
═══════════════════════════════════════════════════════
1. Create / open an unpaid invoice in a supported currency
(PKR, USD, CAD, GBP, AED, EUR — configurable).
- Client opens the invoice (public link or client portal).
- Click "Pay via HBL Pay".
- Confirm amount → Continue to HBL Pay.
- Complete payment on the HBL Pay secure portal.
- Customer returns to success / failed / pending page.
- Callback updates transaction status and records payment.
═══════════════════════════════════════════════════════
4. ADMIN DAILY USE
═══════════════════════════════════════════════════════
• Dashboard widget — totals and quick overview
• Transactions — list / filter payment attempts
• Transaction detail — gateway response + audit logs
• Reports — run and export PDF reports
• Invoice view — client payment history panel
═══════════════════════════════════════════════════════
5. EMAIL NOTIFICATIONS
═══════════════════════════════════════════════════════
Templates created on install (editable in Setup → Email Templates):
• hblpay-payment-success
• hblpay-payment-failed
• hblpay-payment-pending
═══════════════════════════════════════════════════════
6. UNINSTALL (clean removal)
═══════════════════════════════════════════════════════
1. Setup → Modules → Deactivate
2. Click Uninstall
3. Removes:
- All hblpay_* database tables
- Module email templates
- hblpay_* and paymentmethod_hblpay_* options
4. No core Perfex CRM files are modified
═══════════════════════════════════════════════════════
7. DOCUMENTATION
═══════════════════════════════════════════════════════
Open documentation/index.html inside the module package
for a browser-friendly guide.
Related: How to Install · Features · FAQ & Tips