myfatoorah/omnipay

MyFatoorah driver for the Omnipay payment processing library

v3.2.1 2021-06-05 11:34 UTC

Requires

• php: ^7.2|^8.0
• omnipay/common: ^3.1
• php-http/discovery: ^1.14
• php-http/guzzle7-adapter: ^1

Requires (Dev)

• omnipay/tests: ^3|^4

MIT

• Adrian Macneil
• Barry vd. Heuvel

• payment
• checkout
• omnipay
• creditcard

README

MyFatoorah gateway integration for the Omnipay PHP payment processing library

Introduction

Omnipay is a framework agnostic, multi-gateway payment processing library for PHP 5.3+. This package implements acapture support for Omnipay.

Installation

To install you can composer require the package;

$ composer require myfatoorah/omnipay

You can also include the package directly in the composer.json file

{
    "require": {
        "myfatoorah/omnipay": "dev-master"
    }
}

Usage

Creating a payment link

use Omnipay\Omnipay;

$data                      = array();
$data['Amount']            = '50';
$data['OrderRef']          = 'orderId-123'; 
$data['Currency']          = 'KWD';
$data['returnUrl']         = 'http://websiteurl.com/callback.php';
$data['Card']['firstName'] = 'fname';
$data['Card']['lastName']  = 'lname';
$data['Card']['email']     = '[e-mail]';
//
// Do a purchase transaction on the gateway
$transaction               = $gateway->purchase($data)->send();
if ($transaction->isSuccessful()) {
    $invoiceId   = $transaction->getTransactionReference();
    echo "Invoice Id = " . $invoiceId . "<br>";
    $redirectUrl = $transaction->getRedirectUrl();
    echo "Redirect Url = <a href='$redirectUrl' target='_blank'>" . $redirectUrl . "</a><br>";
} else {
    echo $transaction->getMessage();
}

Checking payment status

In the callback, Get Payment status for a specific Payment ID

$callBackData = ['paymentId' => '100202113817903101'];
// or 
$callBackData = ['invoiceid' => '75896'];
$callback     = $gateway->completePurchase($callBackData)->send();
if ($callback->isSuccessful()) {
    echo "<pre>";
    print_r($callback->getPaymentStatus('orderId-123', '100202113817903101'));
} else {
    echo $callback->getMessage();
}

Make a refund

Refund a specific Payment ID

$refundData = ['paymentId' => '100202113817903101', 'Amount'=>1];
$refund     = $gateway->refund($refundData)->send();
if ($refund->isSuccessful()) {
    echo "<pre>";
    print_r($refund->getRefundInfo());
} else {
    echo $refund->getMessage();
}