izal/knet-payment-php

Php SDK for Knet Payment Gateway

3.1 2020-09-19 02:38 UTC

Requires

• php: >=5.5.9
• guzzlehttp/guzzle: >=6.0

Requires (Dev)

• phpunit/phpunit: 4.*

MIT

• Afzal Abbas

• knet
• knet payment
• knet client
• knet sdk
• knet php

README

This is a package to integrate KNET Payment Gateway in Php.

Documentation

Installation

Require this package with composer:

composer require izal/knet-payment-php

Usage:

Initialise the Payment Process

$knetGateway = new KnetBilling([
                'alias'        => 'YOUR_KNET_ALIAS',
                'resourcePath' => '/home/my_web_app_folder/' //Absolute Path to where the resource.cgn file is located
            ]);

configure the URL

$knetGateway->setResponseURL('http://mywebapp.com/payment/response.php');
$knetGateway->setErrorURL('http://mywebapp.com/payment/error.php);
$knetGateway->setAmt(100); 
$knetGateway->setTrackId('123456'); // unique string

// Refer the KnetBilling class for other configurations that can be set like currency, language etc

Now to accept payments from the customer, first step is to Request the KNET gateway for the payment URL, by calling requestPayment method on the KnetBilling Class, we have completed our initial step to collect the payment.

$knetGateway->requestPayment();

Second step is to get the payment URL. and to get the payment url just call the method getPaymentURl

/** 
* Get the URL for the Payment and assign it to a variable. this is the URL we will use to redirect the
* customer to payment gateway 
*/

$paymentURL = $knetGateway->getPaymentURL();

Note: If the Payment URL returns null, most probably you messed up with configuration, or resource path. Check the example in the below section how to ideally request for the payment, which helps to debug for the errors

Third step is to Redirect the user to the Payment URL

// Redirect the USER to the Payment URL
header('Location: '.$paymentURL);

NOTE: Behind the scenes, Customer will be forwarded to the Knet Payment Page, If the payment process was success, Then he will be redirected to the Response URL we set in setResponseURL method. i.e http://mywebapp.com/payment/response.php

Fourth step is to get the response returned from the Knet Gateway and redirect the user to success or error page in your application.

// handle gateway response in http://mywebapp.com/payment/response.php

$paymentID = $_POST['paymentid']; 
$result = $_POST['result']; // if the transaction is success, string "CAPTURED" will be return
$tranid = $_POST['tranid']; // transaction id
$trackid = $_POST['trackid'];

// build URL 
$urlParams = "/?paymentID=" . $paymentID . "&transactionID=" . $transactionID . "&trackID=" . $trackID;

if ($result === "CAPTURED") {
    $redirectURL = 'http://mywebapp.com/payment/success.php';
} else {
    $redirectURL = 'http://mywebapp.com/payment/error.php';
}

return "REDIRECT=" . $redirectURL . $urlParams;

/** Above line is very important
 * KNET expects the return value from the page or method to be starting with 
 * REDIRECT=http://mywebapp.com/payment/success/?paymentID.. etc.
 */ 

This is it. KNET will redirect the USER to the success page in a GET request. i.e to

http://mywebapp.com/payment/success.php

Example

    $responseURL = 'http://mywebapp.com/payment/response.php';
    $successURL = 'http://mywebapp.com/payment/success.php';
    $errorURL = 'http://mywebapp.com/payment/error.php';
    $knetAlias = 'TEST_ALIAS';
    $resourcePath = '/home/mywebapp/';
    $amount = 150;
    $trackID = 'UNIQUETRACKID'; 

    try {

        $knetGateway = new KnetBilling([
            'alias'        => $knetAlias,
            'resourcePath' => $resourcePath
        ]);

        $knetGateway->setResponseURL($successURL);
        $knetGateway->setErrorURL($errorURL);
        $knetGateway->setAmt($amount);
        $knetGateway->setTrackId($trackID);

        $knetGateway->requestPayment();
        $paymentURL = $knetGateway->getPaymentURL();

        // helper function to redirect
        return header('Location: '.$paymentURL);

    } catch (\Exception $e) {
    
        // to debug error message 
        // die(var_dump($e->getMessage()));
        
        return header('Location: '.$errorUrl);
    }