README

For Laravel 5.0 and above

Introduction

This branch has been privaltely modified to allow scheduled transactions. This can not be done unless PayTM approve a Scheduled Payment Account which is not part of their normal accounts. Integrate paytm wallet in your laravel application easily with this package. This package uses official Paytm PHP SDK's.

License

Laravel Paytm Wallet open-sourced software licensed under the MIT license

Getting Started

To get started add the following package to your composer.json file using this command.

composer require aotearoait/laravel-paytm-wallet

Configuring

Note: For Laravel 5.5 and above auto-discovery takes care of below configuration.

When composer installs Laravel Paytm Wallet library successfully, register the Anand\LaravelPaytmWallet\PaytmWalletServiceProvider in your config/app.php configuration file.

'providers' => [
    // Other service providers...
    Anand\LaravelPaytmWallet\PaytmWalletServiceProvider::class,
],

Also, add the PaytmWallet facade to the aliases array in your app configuration file:

'aliases' => [
    // Other aliases
    'PaytmWallet' => Anand\LaravelPaytmWallet\Facades\PaytmWallet::class,
],

One more step to go....

On your config/services.php add the following configuration

'paytm-wallet' => [
    'env' => 'production', // values : (local | production)
    'merchant_id' => 'YOUR_MERCHANT_ID',
    'merchant_key' => 'YOUR_MERCHANT_KEY',
    'merchant_website' => 'YOUR_WEBSITE',
    'channel' => 'YOUR_CHANNEL',
    'industry_type' => 'YOUR_INDUSTRY_TYPE',
    'SUBS_SERVICE_ID' => 'YOUR SUBSCRIPTION ID',
    'SUBS_AMOUNT_TYPE' => 'SUBSCRIPTION TYPE',
    'SUBS_FREQUENCY _UNIT' => 'SUBSCRIPTION FREQUENCY',
    'SUBS_ENABLE_RETRY' => 'ALLOW RETRY',
    'SUBS_EXPIRY_DATE' => 'SUBSCRIPTION EXPIRES ON',
    'SUBS_MAX_AMOUNT' => 'MAX AMOUNT CHARGE PER TRANSACTION',
    'SUBS_START_DATE' => 'START DATE',
    'SUBS_GRACE_DAYS' => 'GRACE PERIOD DAYS'
],

Note : All the credentials mentioned are provided by Paytm after signing up as merchant.

Usage

Making a transaction

<?php

namespace App\Http\Controllers;

use PaytmWallet;

class OrderController extends Controller
{
    /**
     * Redirect the user to the Payment Gateway.
     *
     * @return Response
     */
    public function order()
    {
        $payment = PaytmWallet::with('receive');
        $payment->prepare([
          'order' => $order->id,
          'user' => $user->id,
          'mobile_number' => $user->phonenumber,
          'email' => $user->email,
          'amount' => $order->amount,
          'callback_url' => 'http://example.com/payment/status'
        ]);
        return $payment->receive();
    }

    /**
     * Obtain the payment information.
     *
     * @return Object
     */
    public function paymentCallback()
    {
        $transaction = PaytmWallet::with('receive');
        
        $response = $transaction->response() // To get raw response as object
        //Check out response parameters sent by paytm here -> http://paywithpaytm.com/developer/paytm_api_doc?target=interpreting-response-sent-by-paytm
        
        if($transaction->isSuccessful()){
          //Transaction Successful
        }else if($transaction->isFailed()){
          //Transaction Failed
        }else if($transaction->isOpen()){
          //Transaction Open/Processing
        }
        $transaction->getResponseMessage(); //Get Response Message If Available
        //get important parameters via public methods
        $transaction->getOrderId(); // Get order id
        $transaction->getTransactionId(); // Get transaction id
    }    
}

Make sure the callback_url you have mentioned while receiving payment is post on your routes.php file, Example see below:

Route::post('/payment/status', 'OrderController@paymentCallback');

Important: The callback_url must not be csrf protected Check out here to how to do that

Get transaction status/information using order id

<?php

namespace App\Http\Controllers;

use PaytmWallet;

class OrderController extends Controller
{
    /**
    * Obtain the transaction status/information.
    *
    * @return Object
    */
    public function statusCheck(){
        $status = PaytmWallet::with('status');
        $status->prepare(['order' => $order->id]);
        $status->check();
        
        $response = $status->response() // To get raw response as object
        //Check out response parameters sent by paytm here -> http://paywithpaytm.com/developer/paytm_api_doc?target=txn-status-api-description
        
        if($status->isSuccessful()){
          //Transaction Successful
        }else if($status->isFailed()){
          //Transaction Failed
        }else if($status->isOpen()){
          //Transaction Open/Processing
        }
        $status->getResponseMessage(); //Get Response Message If Available
        //get important parameters via public methods
        $status->getOrderId(); // Get order id
        $status->getTransactionId(); // Get transaction id
    }
}

Initiating Refunds

<?php

namespace App\Http\Controllers;

use PaytmWallet;

class OrderController extends Controller
{
    /**
    * Initiate refund.
    *
    * @return Object
    */
    public function refund(){
        $refund = PaytmWallet::with('refund');
        $refund->prepare([
            'order' => $order->id,
            'reference' => "refund-order-4", // provide refund reference for your future reference (should be unique for each order)
            'amount' => 300, // refund amount 
            'transaction' => $order->transaction_id // provide paytm transaction id referring to this order 
        ]);
        $refund->initiate();
        $response = $refund->response() // To get raw response as object
        
        if($refund->isSuccessful()){
          //Refund Successful
        }else if($refund->isFailed()){
          //Refund Failed
        }else if($refund->isOpen()){
          //Refund Open/Processing
        }else if($refund->isPending()){
          //Refund Pending
        }
    }
}

Check Refund Status

<?php

namespace App\Http\Controllers;

use PaytmWallet;

class OrderController extends Controller
{
    /**
    * Initiate refund.
    *
    * @return Object
    */
    public function refund(){
        $refundStatus = PaytmWallet::with('refund_status');
        $refundStatus->prepare([
            'order' => $order->id,
            'reference' => "refund-order-4", // provide reference number (the same which you have entered for initiating refund)
        ]);
        $refundStatus->check();
        
        $response = $refundStatus->response() // To get raw response as object
        
        if($refundStatus->isSuccessful()){
          //Refund Successful
        }else if($refundStatus->isFailed()){
          //Refund Failed
        }else if($refundStatus->isOpen()){
          //Refund Open/Processing
        }else if($refundStatus->isPending()){
          //Refund Pending
        }
    }
}

Customizing transaction being processed page

Considering the modern app user interfaces, default "transaction being processed page" is too dull which comes with this package. If you would like to modify this, you have the option to do so. Here's how: You just need to change 1 line in you OrderController's code.

<?php

namespace App\Http\Controllers;

use PaytmWallet;

class OrderController extends Controller
{
    /**
     * Redirect the user to the Payment Gateway.
     *
     * @return Response
     */
    public function order()
    {
        $payment = PaytmWallet::with('receive');
        $payment->prepare([
          'order' => $order->id,
          'user' => $user->id,
          'mobile_number' => $user->phonenumber,
          'email' => $user->email,
          'amount' => $order->amount,
          'callback_url' => 'http://example.com/payment/status'
        ]);
        return $payment->view('your_custom_view')->receive();
    }

Here $payment->receive() is replaced with $payment->view('your_custom_view')->receive(). Replace your_custom_view with your view name which resides in your resources/views/your_custom_view.blade.php.

And in your view file make sure you have added this line of code before </body> (i.e. before closing body tag), which redirects to payment gateway.

@yield('payment_redirect')

Here's a sample custom view:

<html>
<head>
</head>
<body>
    <h1>Custom payment message</h1>
    @yield('payment_redirect')
</body>
</html>

That's all folks!

aotearoait / laravel-paytm-wallet

Maintainers

Details