feexpay/feexpay-php

Php sdk of Feexpay - Online payment solution by credit card and mobile money"

1.0.12 2024-07-24 15:30 UTC

MIT

• LOUGBEGNON

README

Feexpay SDK PHP Project - User Guide

This guide explains how to use the Feexpay PHP SDK to easily integrate mobile and card payment methods into your PHP or Laravel application. Follow these steps to get started:

Installation

1. Install a local server like Xampp or Wamp etc ...

2. Install Composer if not already done.

3. Check that Composer is installed by running the following command:

   composer --version
   

Usage in a Simple PHP Environment

1. Create your PHP project.

2. Download the Git repository by opening your terminal and running the following command:

   git clone https://github.com/La-Vedette-Media/feexpay-php-sdk.git
   

3. Create a PHP file, for example, index.php.

4. Use the SDK methods in your PHP file:

   <?php
   include 'src/FeexpayClass.php'; 
   
   $skeleton = new Feexpay\FeexpayPhp\FeexpayClass("shop's id", "token key API", "callback_url", "mode (LIVE, SANDBOX)");
   
   // Using the mobile network payment method (MTN, MOOV)
   $response = $skeleton->paiementLocal("amount", "phone_number", "network (MTN, MOOV)", "Jon Doe", "[e-mail]");
   $status = $skeleton->getPaiementStatus($response);
   var_dump($status);
   
   // Using the card payment method (VISA, MASTERCARD)
   $responseCard = $skeleton->paiementCard("amount", "phoneNumber(66000000)", "typeCard (VISA, MASTERCARD)", "Jon", "Doe", "[e-mail]", "country(Benin)", "address(Cotonou)", "district(Littoral)", "currency(XOF, USD, EUR)");
   $redirectUrl = $responseCard["url"];
   header("Location: $redirectUrl");
   exit();
   ?>

5. You can also integrate a payment button in your PHP page:

   <?php
   include 'src/FeexpayClass.php'; 
   $price = 50;
   $id = "shop's id";
   $token = "token key API";
   $callback_url = 'https://www.google.com';
   $mode = 'LIVE';
   $feexpayclass = new Feexpay\FeexpayPhp\FeexpayClass($id, $token, $callback_url, $mode);
   $result = $feexpayclass->init($price, "button_payee");
   ?>
   <div id='button_payee'></div>

Usage with Laravel

1. In a Laravel project, run the following command to install the Feexpay package:

   composer require feexpay/feexpay-php
   

2. Create a route in your web.php file:

   Route::controller(YourController::class)->group(function () {
       Route::get('feexpay', 'feexpay')->name('feexpay');
   });

3. Create a controller, for example, YourController.php, and use the Feexpay SDK inside this controller to handle payments:

   <?php
   
   namespace App\Http\Controllers;
   use Feexpay\FeexpayPhp\FeexpayClass;
   use Illuminate\Http\Request;
   
   class YourController extends Controller
   {
       public function feexpay()
       {
   
            // Using the card payment method (VISA, MASTERCARD)
   
           $skeleton = new FeexpayClass("shop's id", "token key API", "callback_url", "mode (LIVE, SANDBOX)");
           $responseCard = $skeleton->paiementCard("amount", "phoneNumber(66000000)", "typeCard (VISA, MASTERCARD)", "Jon", "Doe", "[e-mail]", "country(Benin)", "address(Cotonou)", "district(Littoral)", "currency(XOF, USD, EUR)");
           $redirectUrl = $responseCard["url"];
           return redirect()->away($redirectUrl);
   
   
           // Using the mobile network payment method (MTN, MOOV)
   
   
            $skeleton = new FeexpayClass("shop's id", "token key API", "callback_url", "mode (LIVE, SANDBOX)");
            $response = $skeleton->paiementCard("amount", "phone_number", "network (MTN, MOOV)", "Jon Doe","[e-mail]");
            $status = $skeleton->getPaiementStatus($response);
            var_dump($status);
       }
   }

or

<?php

namespace App\Http\Controllers;
use Feexpay\FeexpayPhp\FeexpayClass;
use Illuminate\Http\Request;

class YourController extends Controller
{
    public function feexpay()

    {

     // Using the card payment method (VISA, MASTERCARD)


        $skeleton = new FeexpayClass("shop's id", "token key API", "callback_url", "mode (LIVE, SANDBOX)");
         $responseCard = $skeleton->paiementCard("amount", "phoneNumber(66000000)", "typeCard (VISA, MASTERCARD)", "Jon", "Doe", "[e-mail]", "country(Benin)", "address(Cotonou)", "district(Littoral)", "currency(XOF, USD, EUR)");

         // Display response structure for debugging purposes
         var_dump($responseCard);

         // Check for the presence of the "url" key
         if (isset($responseCard["url"])) {
             $redirectUrl = $responseCard["url"];
             return redirect()->away($redirectUrl);
         } else {
             // Handle the case where "url" is not present in the response
             return response("Erreur de réponse de paiement")->setStatusCode(500);
         }
    }
}

1. Integrate the Feexpay button in a view, for example, welcome.blade.php:

Create a route:

Route::controller(YourController::class)->group(function () {
    Route::get('payment', 'payment')->name('payment') ;
}) ;

Create a controller by example YourController.php

namespace App\Http\Controllers;
use Feexpay\FeexpayPhp\FeexpayClass;
use Illuminate\Http\Request;

class YourController extends Controller
{
  public function payment()
 {
         $data['price']          =  $price = 50;
         $data['id']             =  $id= "shop's id";
         $data['token']          =  $token= "token key API";
         $data['callback_url']   =  $callback_url= 'https://www.google.com';
         $data['mode']           =  $mode='LIVE';
         $data['feexpayclass']   =  $feexpayclass = new FeexpayClass($id, $token, $callback_url, $mode);
         $data['result']         =  $result = $feexpayclass->init($price, "button_payee");

         return view('welcome', $data);
 }
}

Make sure you have your views file for our example is welcome.blade.php

<div id='button_payee'></div>

You can now access the URL defined in the route to perform payments using Feexpay.

Make sure to adapt values like "shop's id", "token key API", addresses, amounts, and other details according to your own configuration and needs.