README

CMI Payment Gateway for Laravel

CMI-Payment-Gateway is a Laravel package for integrating CMI (Centre Monétique Interbancaire) hosted payments with hash generation and callback validation.

Features

Seamless integration with Laravel
Easy to configure and use
Secure payment processing via CMI
Supports multiple SHOPs (SAAS) transactions
Customizable payment callback URL

Requirements

PHP 7.4 or higher
Laravel 7.x or higher
CMI Merchant account

Installation

To install the package, use Composer:

composer require baidouabdellah/cmi-payment-gateway

Publish Configuration

Once installed, publish the configuration file using the following command:

php artisan vendor:publish --tag="cmi-config"

This will create a cmi.php file in your config directory where you can configure your CMI credentials.

Configuration

In the config/cmi.php file, add your CMI Merchant credentials:

return [
    'merchant_id' => env('CMI_MERCHANT_ID'),
    'client_id' => env('CMI_CLIENT_ID'),
    'store_key' => env('CMI_STORE_KEY'),
    'api_key' => env('CMI_API_KEY'),
    'secret_key' => env('CMI_SECRET_KEY'),
    'sandbox' => env('CMI_SANDBOX', true),
    'base_uri' => env('CMI_BASE_URI', 'https://testpayment.cmi.co.ma/fim/est3Dgate'),
    'ok_url' => env('CMI_OK_URL', 'http://localhost/cmi/ok'),
    'fail_url' => env('CMI_FAIL_URL', 'http://localhost/cmi/fail'),
    'shop_url' => env('CMI_SHOP_URL', 'http://localhost/checkout'),
    'callback_url' => env('CMI_CALLBACK_URL', 'http://localhost/cmi/callback'),
    'store_type' => env('CMI_STORE_TYPE', '3D_PAY_HOSTING'),
    'tran_type' => env('CMI_TRAN_TYPE', 'PreAuth'),
    'lang' => env('CMI_DEFAULT_LANG', 'fr'),
    'currency' => env('CMI_DEFAULT_CURRENCY', '504'),
    'hash_algorithm' => env('CMI_HASH_ALGORITHM', 'ver3'),
    'encoding' => env('CMI_ENCODING', 'UTF-8'),
    'auto_redirect' => env('CMI_AUTO_REDIRECT', true),
    'callback_response' => env('CMI_CALLBACK_RESPONSE', true),
    'session_timeout' => env('CMI_SESSION_TIMEOUT', 1800),
    'transport' => env('CMI_TRANSPORT', 'hosted_form'), // hosted_form | server_api
    'http_timeout' => env('CMI_HTTP_TIMEOUT', 15),
];

You can also add these environment variables to your .env file:

CMI_MERCHANT_ID=your_merchant_id
CMI_CLIENT_ID=your_client_id
CMI_STORE_KEY=your_store_key
CMI_API_KEY=your_api_key
CMI_SECRET_KEY=your_secret_key
CMI_SANDBOX=true
CMI_BASE_URI=https://testpayment.cmi.co.ma/fim/est3Dgate
CMI_OK_URL=https://yourwebsite.com/payment/success
CMI_FAIL_URL=https://yourwebsite.com/payment/fail
CMI_SHOP_URL=https://yourwebsite.com/payment/cancel
CMI_CALLBACK_URL=https://yourwebsite.com/payment/callback
CMI_STORE_TYPE=3D_PAY_HOSTING
CMI_TRAN_TYPE=PreAuth
CMI_DEFAULT_LANG=fr
CMI_DEFAULT_CURRENCY=504
CMI_HASH_ALGORITHM=ver3
CMI_ENCODING=UTF-8
CMI_AUTO_REDIRECT=true
CMI_CALLBACK_RESPONSE=true
CMI_SESSION_TIMEOUT=1800
CMI_TRANSPORT=hosted_form
CMI_HTTP_TIMEOUT=15

Usage

To process a payment, use the provided CmiPayment service/facade:

First, inject the CmiPayment service into your controller or use the facade.
Example usage in a controller:

use Baidouabdellah\CmiPaymentGateway\CmiPayment;

class PaymentController extends Controller
{
    public function makePayment(Request $request)
    {
        $payment = app(CmiPayment::class);
        $response = $payment->pay(100.00, 'ORDER12345', 'Order payment', [
            'email' => 'customer@example.com',
            'BillToName' => 'Customer Name',
        ]);

        // $response['gateway_url'] => CMI endpoint
        // $response['payload'] => fields to submit as POST form
        // $response['hash'] => generated hash
        return response()->json($response);
    }
}

Handling Payment Callbacks

In your web.php routes file, you should add a route to handle the CMI callback:

Route::post('/cmi/callback', [PaymentController::class, 'handleCallback'])->name('cmi.callback');

In your PaymentController, handle the callback:

use Illuminate\Http\Request;

class PaymentController extends Controller
{
    public function handleCallback(Request $request)
    {
        $service = app(\Baidouabdellah\CmiPaymentGateway\CmiPaymentService::class);
        $isValid = $service->validateHash($request->all());

        if ($isValid && $request->input('ProcReturnCode') === '00') {
            return view('payment.success');
        }

        return view('payment.failed');
    }
}

Testing

You can test the integration using CMI's sandbox credentials. Ensure you configure the sandbox environment in the cmi.php configuration file or use different .env variables for testing.

Basic Test Card Numbers

Credit card information cannot be used in test mode. Instead, use any of the following test card numbers, along with a valid future expiration date and any random CVC number, to simulate a successful payment transaction.

Card Type	Card Number	CVC (Random)	Expiration Date (Future)
Visa	4242 4242 4242 4242	3 digits	Any future date
Visa (Debit)	4000 0566 5566 5556	3 digits	Any future date
Mastercard	5555 5555 5555 4444	3 digits	Any future date
Mastercard (Series 2)	2223 0031 2200 3222	3 digits	Any future date
Mastercard (Debit)	5200 8282 8282 8210	3 digits	Any future date
Mastercard (Prepaid)	5105 1051 0510 5100	3 digits	Any future date
American Express	3782 822463 10005	4 digits	Any future date
American Express	3714 4963 5398 431	4 digits	Any future date
Discover	6011 1111 1111 1117	3 digits	Any future date
Discover	6011 0009 9013 9424	3 digits	Any future date
Diners Club	3056 9300 0902 0004	3 digits	Any future date
JCB	3566 0020 2036 0505	3 digits	Any future date

Use these details in your testing environment to verify the successful integration of the CMI payment gateway.

Security

If you discover any security issues, please send an email to baidou.abd@gmail.com instead of using the issue tracker.

Support

Abdellah Baidou
+212 661-176711
baidou.abd@gmail.com

License

This package is open-sourced software licensed under the MIT license.

baidouabdellah / cmi-payment-gateway

Maintainers

Package info

Statistics

Security

README

CMI Payment Gateway for Laravel

Features

Requirements

Installation

Publish Configuration

Configuration

Usage

Handling Payment Callbacks

Testing

Basic Test Card Numbers

Security

Support

License