README

SSLCommerz Payment Gateway PHP SDK — initiate payments, validate transactions, handle IPN callbacks. Built for Bangladesh's leading payment gateway.

composer require jarir-ahmed/sslcommerz

Quick Start

use JarirAhmed\SSLCommerz\SSLCommerz;

$ssl = new SSLCommerz(
    storeId: 'your_store_id',
    storePassword: 'your_store_password',
    isLive: false // false = sandbox, true = production
);

Initiate Payment

$result = $ssl->initiate([
    'amount'          => 5000,
    'currency'        => 'BDT',
    'tran_id'         => $ssl->generateTransactionId('ORDER'),
    'product_name'    => 'Business SMS Package',
    'product_category' => 'Digital Service',
    'cus_name'        => 'John Doe',
    'cus_email'       => 'john@example.com',
    'cus_phone'       => '01712345678',
    'cus_add1'        => '12 Gulshan Avenue',
    'cus_city'        => 'Dhaka',
    'cus_country'     => 'Bangladesh',
    'success_url'     => 'https://example.com/payment/success',
    'fail_url'        => 'https://example.com/payment/fail',
    'cancel_url'      => 'https://example.com/payment/cancel',
    'ipn_url'         => 'https://example.com/payment/ipn',
]);

// Redirect customer to the gateway
header('Location: ' . $result['GatewayPageURL']);

Validate Transaction

// After payment callback, validate with val_id
$validation = $ssl->validate($_POST['val_id']);

if ($validation['status'] === 'VALID') {
    // Payment confirmed — activate order
}

Handle IPN

// In your IPN endpoint:
$ipn = $ssl->verifyIpn($_POST);

if ($ipn['verified']) {
    // Payment confirmed via IPN
}

API

__construct(string $storeId, string $storePassword, bool $isLive = false)

Create a new SSLCommerz instance. Use isLive: false for sandbox testing.

initiate(array $data): array

Start a payment session. Returns gateway URLs and session info.

Required fields: amount, tran_id, product_name, cus_name, cus_email, cus_phone, success_url, fail_url, cancel_url

validate(string $valId): array

Validate a completed transaction. Call this in your success handler.

verifyIpn(array $postData): array

Verify IPN callback data. Pass $_POST directly.

generateTransactionId(string $prefix = 'SSLCZ'): string

Generate a unique transaction ID.

isSandbox(): bool

Check if running in sandbox mode.

Environments

Requirements

• PHP 7.2+
• ext-curl
• ext-json

Testing

composer install
composer test

Manual API Testing

To test against the real sandbox:

$ssl = new SSLCommerz('your_sandbox_store_id', 'your_sandbox_password');
$result = $ssl->initiate([...]);
echo $result['GatewayPageURL']; // Open in browser

License

MIT

jarir-ahmed-sslcommerz