Integrate SSLCOMMERZ with WHMCS

SSLCOMMERZ is a leading payment aggregator in Bangladesh. Merchants can accept online payments through cards, mobile banking, and other supported channels on websites and billing platforms.

If you use WHMCS and need a dependable way for clients to pay invoices online, this module connects WHMCS to SSLCOMMERZ using their API v4.

This build focuses on stable behaviour on supported WHMCS releases: validated callbacks, optional Easy Checkout (hosted UI), automatic IPN-style URLs derived from your System URL, and PHP compatibility from 7.4 through 8.4.

Requirements

• WHMCS v8.0, v9.0, or later — standard gateway under modules/gateways/.
• PHP 7.4, 8.0, 8.1, 8.2, 8.3, or 8.4 — validated JSON/cURL usage.
• PHP cURL extension (required).
• PHP JSON (usually bundled); OpenSSL for HTTPS.
• SSLCOMMERZ Sandbox account for testing and/or Live merchant credentials for production.

Features

• Full SSLCOMMERZ API v4 session flow (hosted gateway URL).
• Optional Easy Checkout — embedded/popup hosted UI via gateway setting.
• Classic redirect mode — form POST to SSLCOMMERZ GatewayPageURL when Easy Checkout is off.
• Automatic success, fail, cancel, IPN, and Easy Checkout helper URLs from WHMCS System URL.
• Browser return handler validates payments via SSLCOMMERZ validation API before marking paid.
• IPN (server-to-server) with validation API check and risk-level handling.
• Invoice metadata: value_a / value_b / value_c (description, WHMCS return URL trace, invoice ID).
• Post-payment redirect targets guest-safe invoice viewing (viewinvoice.php with uuid when available).
• Effective System URL taken from WHMCS configuration when building redirects.
• Session behaviour tuned for cross-site gateway returns (SameSite / Sign-In Integration scenarios).
• Transaction ID taken from SSLCOMMERZ validation response where available (consistent with IPN).
• API v4 product/session defaults in code — minimal clutter in gateway settings UI.
• WHMCS Apps & Integrations metadata (whmcs.json) for discovery and docs links.

Installation steps

1. Download this SSLCOMMERZ WHMCS module package (ZIP or repository archive).
2. Extract it on your computer.
3. Upload the included modules folder to the root of your WHMCS installation (FTP, SFTP, or file manager).
4. Merge carefully — adds files under modules/gateways/ and related paths only; do not remove unrelated WHMCS files.
5. Log in to WHMCS Admin.
6. Open System Settings → Apps & Integrations, or Setup → Payments → Payment Gateways, depending on your WHMCS version.
7. Search for SSLCOMMERZ, open SSLCOMMERZ Payment Gateway, and activate it.
8. Configure display name, Payment Button Label, Store ID, Store Password, enable Sandbox / Test Mode if testing, and Easy Checkout if you want the hosted UI flow.
9. Save changes.
10. Complete at least one Sandbox payment on a test invoice and confirm the invoice is marked paid as expected.

Useful endpoints

Paths are appended to your WHMCS System URL:

• Browser return (success / fail / cancel): modules/gateways/callback/sslcommerz.php
• IPN: modules/gateways/callback/sslcommerz_ipn.php
• Easy Checkout helper: modules/gateways/callback/sslcommerz_checkout.php

Documentation

SSLCOMMERZ official API v4 documentation:

https://developer.sslcommerz.com/doc/v4/

Author and support

• Author: SOFT HAB Team
• Homepage: https://softhab.com

For SSLCOMMERZ product or credential questions, use SSLCOMMERZ official support channels. For integration documentation inquiries, SSLCOMMERZ lists integration@sslcommerz.com on their developer resources.