mst-ghi/larapool

A Laravel library to connect all Iraninan payments gateways

v1.1.0 2021-08-16 10:24 UTC

Requires

• ext-curl: *
• ext-json: *
• ext-soap: *
• illuminate/database: >=5.7.17
• illuminate/support: >=5.7.17
• nesbot/carbon: *

MIT

• Mostafa Gholami

• payment
• pay
• gateway
• laravel
• Bank
• port
• Payline
• iran
• shaparak
• zarinpal
• saman
• pardakht
• dargah
• Meli
• mellat
• pasargad
• parsian
• sadad
• jahanpay
• poolport
• ipay
• pay-ir

README

A Laravel (+7) package to connect all Iraninan payments gateways

Active ports :

• IDPay
• Mellat
• Sadad
• Zarinpal
• Payline
• Jahanpay
• Saderat
• IranKish
• Saman
• Parsian
• Pay
• JiBit
• AP
• BitPay

Installing :

Step 1 :

composer require mst-ghi/larapool

Step 2 : Apply the following changes to the config/app.php file

   'providers' => [
         MstGhi\Larapool\LarapoolServiceProvider::class
   ],

  'aliases' => [
        'Larapool' => MstGhi\Larapool\Larapool::class
   ]

Step 3 : Publishing required files

php artisan vendor:publish 

Choice and enter number of MstGhi\Larapool\LarapoolServiceProvider to publish resource files. Published files include config and migration files

Step 4 : Create transaction tables

php artisan migrate

Package configs

The installation operation is complete. Now open the larapool.php file in the config/larapool.php and enter the settings related to your desired banking portal.

Create new transaction

Your project Order model must use the TransactionAble trait. This trait adds relation transactions() to order model
You have to register the order and then create a transaction for that order

$order = Order::create([
    'paid_price' => 1000
    // your data
]);

$resId = \MstGhi\Larapool\LarapoolTransaction::generateResId();

// create new transaction
$order->transactions()->create([
    'user_id' => $user->id, // customer id here, this is optional
    'port_id' => \MstGhi\Larapool\Larapool::P_IDPAY,
    'price' => $order->paid_price,
    'res_id' => $resId,
    'platform' => \MstGhi\Larapool\Larapool::PLATFORM_WEB,
    'last_change_date' => strtotime(now()),
]);

// In the next step, transfer to the bank portal using resId

In the next step, transfer to the bank portal using $resId

Redirect to bank

Can be redirected directly to the bank portal using the redirect()
or
Received the relevant link and connected to the bank portal in other ways using the redirectLink()

The choice of redirect method to the bank depends on your project

use Illuminate\Http\Response;
use Illuminate\Support\Facades\Log;
use MstGhi\Larapool\LarapoolTransaction;
use MstGhi\Larapool\Larapool;
use MstGhi\Larapool\IDPay\IDPay;
use MstGhi\Larapool\Exceptions\NotFoundTransactionException;

public function redirect($resId)
{
    $exception = null;
    
    $transaction = LarapoolTransaction::with(['transactionable'])->where('res_id', $resId)->first();
    
    if (!$transaction) {
    
        $exception = new NotFoundTransactionException();
        
    } else {
    
        /** @var IDPay $larapool */
        $larapool = new Larapool(Larapool::P_IDPAY);
        
        try {
        
            $refId = $larapool->setTransaction($transaction)->ready()->refId();
            // any operation on $refId here ...
        
            /**
            * redirect by php header() method automatically 
            */
            $larapool->redirect();
            
            // Or ...
            
            /**
            * relevant link and connected to the bank portal in other ways
            */
            $link = $larapool->redirectLink();
            
            return response()->json([ 'link' => $link ], Response::HTTP_OK);
            
        } catch (Exception $e) {
        
            $exception = $e;
            
        }
    }
        
    if ($exception) {
    
        Log::critical(
            "Error in getting payment url: {$exception->getMessage()} #transactionId: {$transaction->id}"
        );
        
        throw $exception;
    }
    
}

Callback from bank

use Illuminate\Support\Facades\Log;
use MstGhi\Larapool\Exceptions\NotFoundTransactionException;
use MstGhi\Larapool\LarapoolTransaction;
use MstGhi\Larapool\Larapool;
use MstGhi\Larapool\IDPay\IDPay;
use Carbon\Carbon;

public function callback(LarapoolTransaction $transaction, $resId)
    {
        if (($transaction && !$resId) || ($transaction && $transaction->res_id != $resId)) {
            throw new NotFoundTransactionException();
        }
        
        // load transactionable, this is use as orderId
        $transaction->load(['transactionable']);

        try {
             /** @var IDPay $larapool */
             $larapool = new Larapool(Larapool::P_IDPAY);

            /** verify transaction [bank] */
            $larapool->setOrderId($transaction->transactionable->id)->verify($transaction);

            $trackingCode = $larapool->trackingCode();
            $cardNumber = $larapool->cardNumber();

            $transaction->update([
                'tracking_code' => $trackingCode,
                'card_number' => $cardNumber,
                'status' => LarapoolTransaction::TRANSACTION_SUCCEED,
                'payment_date' => strtotime(Carbon::now()),
                'last_change_date' => strtotime(Carbon::now()),
            ]);
            
            // any operation after success payment here ...
            
        } catch (\Exception $e) {
            $message = $e->getMessage();
            Log::critical("Error in verifying payment: $message #transactionId: {$transaction->id}");
           
            $transaction->update([
                'status' => LarapoolTransaction::TRANSACTION_FAILED,
                'last_change_date' => strtotime(Carbon::now()),
            ]);
            
            // any operation after failed payment here ...
        }
    }