Search Knowledge Base Articles

HBL Pay Payment Gateway — How to Install

← Back to HBL Pay Payment Gateway overview

How to Install — HBL Pay Payment Gateway

Module folder: modules/hblpay_gateway/   Version: v1.0.0

Enterprise HBL Pay payment gateway integration for Perfex CRM

Before you begin

  • Backup your database (Setup → Backup or your host backup tool).
  • Use a staff account with Modules / Settings access.
  • PHP version and Perfex CRM version should match the module README requirements when listed.
  • Keep the module folder name exactly hblpay_gateway.

Step-by-step installation

  1. Upload the hblpay_gateway folder into your CRM modules/ directory (FTP, cPanel, or Setup → Modules → Upload when available).
  2. Log in to Admin.
  3. Go to Setup → Modules.
  4. Find HBL Pay Payment Gateway and click Activate (or Upgrade if already installed).
  5. Wait for migrations/tables to finish — do not refresh mid-activation.
  6. Go to Setup → Staff → Roles and assign permissions for this module.
  7. Open HBL Pay Payment Gateway → Settings and save defaults.

Install notes from README

Installation

  1. Upload hblpay_gateway to modules/ in your Perfex CRM installation.
  2. Activate under Setup → Modules.
  3. Configure Setup → Settings → Payment Gateways → HBL Pay.
  4. Assign permissions under Setup → Staff → Roles (HBL Pay capabilities).

Uninstall

  1. Deactivate the module under Setup → Modules.
  2. Uninstall — all module tables, email templates, and gateway settings are removed automatically.

After activation — configuration checklist

  1. Go to Setup → Modules and activate HBL Pay Payment Gateway.
  2. If prompted, click Upgrade Database or reload admin — migrations run automatically.
  3. Assign permissions under Setup → Staff → Roles.
  4. Configure under Setup → Settings → Payment Gateways → HBL Pay.
  5. Perfex CRM 2.3+ (3.x recommended)
  6. PHP 7.4+ (8.1+ recommended)
  7. MySQL 5.7+ / MariaDB 10.3+ (InnoDB)
  8. PHP extensions: mysqli, json, mbstring, curl, openssl
  9. HBL Pay merchant account (sandbox or live)

Official documentation — Installation

Installation

  1. Extract the main ZIP and upload the hblpay_gateway folder to modules/ in your Perfex CRM installation.
  2. Go to Setup → Modules and activate HBL Pay Payment Gateway.
  3. If prompted, click Upgrade Database or reload admin — migrations run automatically.
  4. Assign permissions under Setup → Staff → Roles.
  5. Configure under Setup → Settings → Payment Gateways → HBL Pay.

No core CRM files are modified. Tables, email templates, and options are created on activation.

Requirements

  • Perfex CRM 2.3+ (3.x recommended)
  • PHP 7.4+ (8.1+ recommended)
  • MySQL 5.7+ / MariaDB 10.3+ (InnoDB)
  • PHP extensions: mysqli, json, mbstring, curl, openssl
  • HBL Pay merchant account (sandbox or live)

Verify installation (checklist)

  1. Setup → Modules shows HBL Pay Payment Gateway as Active.
  2. Admin sidebar shows the HBL Pay Payment Gateway menu for an admin user.
  3. Setup → Staff → Roles lists this module's permission groups.
  4. Opening HBL Pay Payment Gateway → Settings loads without PHP errors.
  5. Creating one sample record succeeds and appears in the list/table.
  6. (If used) Cron-dependent features have Perfex CRM cron enabled on the server.

After install — first actions

  1. Create master data required by this module.
  2. Create one sample record and walk it through approve/complete if applicable.
  3. Train staff using the Quick Start Guide.

Related: Features · Quick Start · FAQ · Version & Changelog

Did you find this article useful?

Related Articles