softon/indipay

The Laravel 5 Package for Indian Payment Gateways. Currently supported gateways: CCAvenue, PayUMoney, EBS, CitrusPay, InstaMojo, ZapakPay, Mocker

v1.2.4 2020-09-23 09:46 UTC

README

The Laravel 5+ Package for Indian Payment Gateways. Currently supported gateway: CCAvenue, PayUMoney, EBS, CitrusPay ,ZapakPay (Mobikwik), Paytm, Mocker

For Laravel 4.2 Package Click Here

Installation

Step 1: Install package using composer

    composer require softon/indipay

Step 2: Add the service provider to the config/app.php file in Laravel (Optional for Laravel 5.5+)


    Softon\Indipay\IndipayServiceProvider::class,

Step 3: Add an alias for the Facade to the config/app.php file in Laravel (Optional for Laravel 5.5+)


    'Indipay' => Softon\Indipay\Facades\Indipay::class,

Step 4: Publish the config & Middleware by running in your terminal


    php artisan vendor:publish --provider="Softon\Indipay\IndipayServiceProvider" 

Step 5: Modify the app\Http\Kernel.php to use the new Middleware. This is required so as to avoid CSRF verification on the Response Url from the payment gateways. You may adjust the routes in the config file config/indipay.php to disable CSRF on your gateways response routes.

NOTE: You may also use the new VerifyCsrfToken middleware and add the routes in the $except array.

App\Http\Middleware\VerifyCsrfToken::class,

to

App\Http\Middleware\VerifyCsrfMiddleware::class,

Usage

Edit the config/indipay.php. Set the appropriate Gateway parameters. Also set the default gateway to use by setting the gateway key in config file. Then in your code...

 use Softon\Indipay\Facades\Indipay;  

Initiate Purchase Request and Redirect using the default gateway:-

      /* All Required Parameters by your Gateway will differ from gateway to gateway refer the gate manual */
      
      $parameters = [
        'transaction_no' => '1233221223322',
        'amount' => '1200.00',
        'name' => 'Jon Doe',
        'email' => 'jon@doe.com'
      ];
      
      $order = Indipay::prepare($parameters);
      return Indipay::process($order);

Please check for the required parameters in your gateway manual. There is a basic validation in this package to check for it.

You may also use multiple gateways:-

      // gateway = CCAvenue / PayUMoney / EBS / Citrus / InstaMojo / ZapakPay / Paytm / Mocker
      
      $order = Indipay::gateway('Paytm')->prepare($parameters);
      return Indipay::process($order);

Get the Response from the Gateway (Add the Code to the Redirect Url Set in the config file. Also add the response route to the remove_csrf_check config item to remove CSRF check on these routes.):-

 
    public function response(Request $request)
    
    {
        // For default Gateway
        $response = Indipay::response($request);
        
        // For Otherthan Default Gateway
        $response = Indipay::gateway('NameOfGatewayUsedDuringRequest')->response($request);

        dd($response);
    
    }  

The Indipay::response will take care of checking the response for validity as most gateways will add a checksum to detect any tampering of data.

Important point to note is to store the transaction info to a persistant database before proceding to the gateway so that the status can be verified later.

Payment Verification

From version v1.0.12 Indipay has started implementing verify method in some gateways so that the developer can verify the payment in case of pending payments etc.

    $order = Indipay::verify([
        'transaction_no' => '3322344231223'
    ]);

The parameters to be passed, again depends on Gateway used.

Verify Feature Currently Supported in : Paytm, Mocker