Create payment gateway App

In PayPlans, after choosing a desired plan, when the user logins, he/she needs to select the payment method through which payment has to be made. After payment selection when user clicks on checkout,the work of payment gateway app starts.Following events can be triggered.

1.function isApplicable($refObject = null, $eventName='')

       isApplicable function is used to find whether the current app-instance should be triggered for given event and reference object. If you want to decide to trigger app as per event name then return true from here.

function isApplicable($refObject = null, $eventName='')
{
   // return true for event onPayplansControllerCreation
   if($eventName == 'onPayplansControllerCreation'){
     return true;
   }
  return parent::isApplicable($refObject, $eventName);
}

2. function onPayplansControllerCreation($view, $controller, $task, $format)

     onPayplansControllerCreation,this event is triggered just before creation of controller instance. In payment gateways, we work only when view is payment and task is notify. Developers can process notification and can extract values from notification and get details, for example, for which invoice the notification arrives. They can extract invoice key or payment key from the payment notification.

function onPayplansControllerCreation($view, $controller, $task, $format)
 {
  if($view == 'payment' && $task == 'notify')
   {
   $paymentKey = JRequest::getVar('invoice_num', null);
   if($paymentKey){
      $prefix = JString::substr($paymentKey, 0,3);
      if($prefix !== 'PK_')
      {
        //get payment key from order key
        $orderId     = XiHelperUtils::getIdFromKey($paymentKey);
        $order     =  PayplansOrder::getInstance($orderId);     
        $paymentId = $order->getParam('payment_id');
        $paymentKey = XiHelperUtils::getKeyFromId($paymentId);
      }
     else 
     {
      $paymentKey = JString::substr($paymentKey, 3);
     }
  JRequest::setVar('payment_key', $paymentKey, 'POST');
  return true;
 }
 

3. function onPayplansPaymentForm(PayplansPayment $payment, $data = null)

       When user selects payment gateway to pay and clicks on checkout button. He will be redirected to new page. Developers of app can decide what HTML should render using onPayplansPaymentForm event. HTML code can be a form or just a simple button. There are some payment gateways that allow to render the form at our end only. In that case you need to render the form HTML (You may take help of Authorize.net App for this case) and there are some, which redirect to there own site, for further processing, after check out (You may take help of Paypal App for this case).

function onPayplansPaymentForm(PayplansPayment $payment, $data = null)
{
  $invoice = $payment->getInvoice(PAYPLANS_INSTANCE_REQUIRE);
  $amount  = $invoice->getTotal();
  $this->assign('post_url', XiRoute::_("index.php?option=com_payplans&view=payment&task=complete&payment_key=".$payment->getKey()));
  $this->assign('payment', $payment);
  $this->assign('invoice', $invoice);
  $this->assign('amount', $amount);
 return $this->_render('form');<br>}<br>

4. public function onPayplansPaymentAfter(PayplansPayment $payment, $action, $data, $controller)

This event can be use to post the data(as filled in the form) to their respective payment gateways. Recurring profiles can be created, if plan is of recurring type.If any error is there during transaction, then it will be redirected to the error page by calling the parent event.

function onPayplansPaymentAfter(PayplansPayment $payment, $action, $data, $controller)
{
  if($action == 'cancel'){
    return true;
  }
  if($invoice->isRecurring()){
 
  //Will create recurring profile and then post the data to the payment gateway.
    $this->_processRecurringRequest($payment, $data);
  }
  else {
   //Will post the the data to the desired payment gateway.
   $this->_processNonRecurringRequest($payment, $data);
  }
   $payment->save();
 
   //calling of parent event is required to check whether
   // there is any error during the above process.
   return parent::onPayplansPaymentAfter($payment, $action, $data, $controller);<br>} <br>

5. function onPayplansPaymentNotify($payment, $data, $controller)

Whenever payment notification arrives, onPayplansPaymentNotify event can be triggered. Processing of notification is done, means find out what type of notification is there whether it is for Sign-u(R), Payment, Refund, Hold or expire and verify whether transaction has been successfully done or not.Notification also contain information regarding the amount.So,if the amount is positive or negative,the set the transaction amount and message accordingly else make the taransaction for zero amount. If any error is present, then redirect to error page.

function onPayplansPaymentNotify($payment, $data, $controller)
{        
    $invoice = $payment->getInvoice(PAYPLANS_INSTANCE_REQUIRE);
 
    // if its a recurring subscription
    if(isset($data['x_subscription_id']) && $data['x_subscription_id'] ){
 
   // get the transaction instace of lib
   $transaction = PayplansTransaction::getInstance();
   $transaction->set('user_id', $payment->getBuyer())
               ->set('invoice_id', $invoice->getId())
               ->set('payment_id', $payment->getId())
               ->set('gateway_txn_id', isset($data['x_trans_id']) ? $data['x_trans_id'] : 0)
               ->set('gateway_subscr_id', isset($data['x_subscription_id']) ? $data['x_subscription_id'] : 0)
               ->set('gateway_parent_txn', isset($data['parent_txn_id']) ? $data['parent_txn_id'] : 0)
              ->set('params', PayplansHelperParam::arrayToIni($data));
 
 
   $errors = $this->_processNotification($transaction, $data, $payment);
   $transaction->save();
   return count($errors) ? implode("\n", $errors) : ' No Errors';
  }
 
}

6. When you want to terminate any payment, then onPayplansPaymentTerminate event is triggered. This event is triggered when the plan is of recurring type.
For example, if recurrence count is set to 5 but, after 2 recurrence if user want to unsubscribe it, then this event can be used to terminate the order.

public function onPayplansPaymentTerminate(PayplansPayment $payment, $controller)
  {
    $transactions = $payment->getTransactions();
    foreach($transactions as $transaction){
  $subscriptionId = $transaction->get('gateway_subscr_id', 0);
   if(!empty($subscriptionId)){
      break;
          }
    }
    $arbInstance->setRefId($payment->getKey()); 
    $response = $arbInstance->cancelSubscription($subscriptionId);
 
    $invoice = $payment->getInvoice(PAYPLANS_INSTANCE_REQUIRE); 
    $txn = PayplansTransaction::getInstance();
    $txn->set('user_id', $payment->getBuyer())
      ->set('invoice_id', $invoice->getId())
      ->set('payment_id', $payment->getId())
      ->set('gateway_txn_id',  isset($data['x_trans_id']) ? $data['x_trans_id'] : 0)
      ->set('gateway_subscr_id', $subscriptionId)
      ->set('gateway_parent_txn', isset($data['parent_txn_id']) ? $data['parent_txn_id'] : 0);
 
    $txn->set('message', 'COM_PAYPLANS_PAYMENT_FOR_CANCEL_ORDER')->save();  
    return $this->_render('cancel_success');
}