maree/myfatoorah

package to pay with myfatoorah payment services

dev-main 2022-03-22 11:18 UTC

MIT

• mohamed maree

README

Installation

You can install the package via Composer.

composer require maree/myfatoorah

Publish your myfatoorah config file with

php artisan vendor:publish --provider="maree\myfatoorah\MyfatoorahServiceProvider" --tag="myfatoorah"

then change your myfatoorah config from config/myfatoorah.php file

    "token"  => "" ,//To generate one follow instruction here https://myfatoorah.readme.io/docs/live-token.
    "mode"   => "test", //test|live

Usage

creat routes for checkout,callback and error pages

Route::get('checkout', [\App\Http\Controllers\MyFatoorahController::class, 'checkout']);
Route::get('payment/callback', [\App\Http\Controllers\MyFatoorahController::class, 'callback']);
Route::get('payment/error', [\App\Http\Controllers\MyFatoorahController::class, 'error']);

At the controller

use maree\myfatoorah\MyfatoorahPay;
    public function checkout(){
        $pay      = new MyfatoorahPay();
        $postFields = [
            'NotificationOption' => 'Lnk',     //'SMS', 'EML', or 'ALL'
            'InvoiceValue'       => 1,   //the price the customer will pay
            'CustomerName'       => 'maree', 
            'DisplayCurrencyIso' => 'SAR',
            'MobileCountryCode'  => '+966',
            'CustomerMobile'     => '123456789',
            'CallBackUrl'        => route('callback'),    //the route that will be redirected to in the success
            'ErrorUrl'           => route('error'), //the route that will be redirected to in the fail
            'Language'           => 'ar',
            'CustomerReference'  => auth()->id(),//user id    // the refrence to the customer and wil be returned in the respone of the success
            'UserDefinedField'   => 'user',//user,product,...  //(optional) extra key and wil be returned in the respone of the succes
        ];
        $data = $pay->getInvoiceURL($postFields);
        return redirect($data['invoiceURL']);
    }

Get callback to check payment status

use maree\myfatoorah\MyfatoorahPay;
   
    public function callback(){
        $pay          = new MyfatoorahPay();
        $responseData = $pay->getPaymentStatus(request('paymentId'), 'PaymentId');
        $responseDataArr = json_decode(json_encode($responseData), true);
        if ($responseDataArr['focusTransaction']['TransactionStatus'] == 'Succss') { //check if the transaction is the success
            $user_id = $responseDataArr['CustomerReference'];    //get the cutomer refrence
            if ($responseDataArr['UserDefinedField'] == 'user') { //get the extra key
                // code
            } elseif ($responseDataArr['UserDefinedField'] == 'product') {
                //code
            }
            return response()->json(['status' => 'success','msg' => 'payment success']);
        }else{
            return response()->json(['status' => 'fail','msg' => 'payment fail']);
        }
    }

Error page

use maree\myfatoorah\MyfatoorahPay;
   
    public function error(Request $request) {
   	    return response()->json(['status' => 'fail','msg' => 'payment fail']);
    }

You can get test cards from https://myfatoorah.readme.io/docs/test-cards