Skip to content

Latest commit

 

History

History
287 lines (211 loc) · 8.2 KB

README.md

File metadata and controls

287 lines (211 loc) · 8.2 KB
Raw

yii2-paystack

YII 2 component for paystack payment integration

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require smladeoye/yii2-paystack

or add

"smladeoye/yii2-paystack": "1.0.0" to the require section of your composer.json file.

Configuration

In your configuration file (web.php) register the component with the necessary configurations, for example:

'components'=>[
    //  ...
    'Paystack' => [
        'class' => 'smladeoye\paystack\Paystack',
    	'environment' => 'test',
    	'testPublicKey'=>'pk_test_365589cc6b0e95f1fb53fa0eeaef6b1819f1b0f2',
    	'testSecretKey'=>'sk_test_1a4a88eaec6f4f3b23771edb2c60fe8d8b95cbe',
    	'livePublicKey'=>'',
    	'liveSecretKey'=>'',
    ],
    //  ...
]

Usage Example

//Initializing a payment transaction

$paystack = Yii::$app->Paystack;

$transaction = $paystack->transaction();
$transaction->initialize(['email'=>'[email protected]','amount'=>'100000','currency'=>'NGN']);

//check if an error occured during the operation, you can check

response property for response gotten for any operation
if (!$transaction->hasError)
{
    // redirect the user to the payment page gotten from the initialization
    $response = $transaction->getResponse()
    $transaction->redirect();
}
else
{
    // display message
    echo $transaction->message;

    // get all the errors information regarding the operation from paystack
    $error = $transaction->getError();
}

There are seven operations available that can be performed which have been grouped based on Paystack's own grouping. Each of the operations also have their individual methods that can be called for performing different actions (create, list -- fetchAll, fetch, update,...) which can accept all the necessary parameters as an array.

The following are the available operations and methods (all sample codes are based on the demo configuration above):

  1. customer: To initiatiate any customer operation:
$paystack = Yii::$app->Paystack;
$customer = $paystack->customer();

Distinct methods available to customer:

  • whitelist --> whitelist a particular customer.Example:
      $customer->whitelist($customer_id);
  • blacklist --> blacklist a particular customer.Example:
      $customer->blacklist($customer_id);
  1. transaction: To initiate a transaction operation:
$paystack = Yii::$app->Paystack;
$transaction = $paystack->transaction();

Distinct methods available to transaction:

  • initialize --> initialize a transaction; an authorization url is generated from this method after which the redirect method can then be called to redirect to the payment page. Example:
$transaction->initialize(['email'=>'[email protected]','amount'=>'10000']);
if (!$transaction->hasError)
      $transaction->redirect();
  • verify --> verify a transaction.Example:
      $transaction->verify($trans_reference);
  • charge --> charge authorization for recurring transactions.Example:
$transaction->charge($options = []);
  • timeline --> timeline for a particular transactions.Example:
$transaction->timeline($trx_id);
  • total --> get total for transactions within a specified range.Example:
 $transaction->total($from,$to);
 //An array could be provided instead with the available parameters in key => value format.
  • export --> export a range of transaction details;a url is generated from this method from which the file can be downloaded. To get the path simpley call the path method or call the download method to download the file. Example:
   $transaction->export($options = []);

  //get download link url
  $transaction->getPath();

OR to download the file, call:

      $transaction->download();
  1. subscription: To initiate a subscription operation:
$paystack = Yii::$app->Paystack;
$subscription = $paystack->subscription();

Distinct methods available to subscription:

  • enable --> enable a customer subscription.Example:
    $subscription->enable($code, $token);
    //an array can be provided instead, containing the necessary parameters as key => value
  • disable --> disable a customer subscription.Example:
    $subscription->disable($code, $token);
    //an array can be provided instead, containing the necessary parameters as key => value
  1. subaccount: To initiate a subaccount operation:
$paystack = Yii::$app->Paystack;
$subaccount = $paystack->subaccount();

Distinct methods available to subaccount:

  • listBank --> list the available bank for creating subaccounts on the system.Example:
        $subaccount->enable($code, $token);
        //an array can be provided instead, containing the necessary parameters as key => value
  1. plan: To initiate a plan operation:
$paystack = Yii::$app->Paystack;
$plan = $paystack->plan();

Plan operation contains all the basic methods (create,fetch,fetchAll,update);

  1. page: To initiate a page operation:
$paystack = Yii::$app->Paystack;
$page = $paystack->page();

Distinct methods available to page:

  • checkAvailability --> check the availability of a particular slug.Example:
        $page->checkAvailability($slud_id);
  1. settlement: To initiate a settlement operation:
$paystack = Yii::$app->Paystack;
$settlement = $paystack->settlement();

Distinct methods available to settlement:

  • fetchAll --> fetch all settlements.Example:
$settlement->fetchAll($from_date,$to_date);
//an array can be provided instead, containing the necessary parameters as key => value

The follwing methods are also available:

  • fetchAll: The fetchall/list method is available for all operations.Example:
        $customer->fetchAll(['page'=>'','perPage'=>'']);
  • create: The create method is available for customer, subscription, subaccount, page and plan operations.Example:
        $customer->create(['email'=>'[email protected]']);
  • fetch --> The fetch method is available to all operations except settlement.Example:
        $customer->fetch($customer_id);
  • update --> The update method is available for customer, subaccount, page and plan operations.Example:
        $customer->update($id,$info = array();

Using the Paystack Inline Payment Widget

To use the widget, call the widget from your view and set the widget parameters, example:

use smladeoye\paystack\widget\PaystackWidget;

    echo PaystackWidget::widget(
        [
        //set the text to be displayed on the button
            'buttonText'=>'PAY',
        //array to set other button attributes like id, class,style etc
            'buttonOptions'=>array(
                'class'=>'btn btn-danger',
                'style'=>'width: 80px;',
            ),
        //array to set all necessary paystack inline payment options
            'options'=>[
                //your paystack public key
                'key'=>Yii::$app->Paystack->testPublicKey,
                'email'=>'[email protected]',
                'ref'=>'123456789',
                'amount'=>'200000',
                'currency' =>'NGN',
                'plan' =>'my-plan',
                'quantity' =>'2',
                //callbackUrl can be set, where the tansaction reference would be passed as GET parameter
                'callbackUrl' =>'www.google.com',
                //also u can override the default with the callback option, simply provide javascript anonymous function as a string
                //'callback'=>'function(response){alert(response.trxref);};',
            ],
        ]
    );