ovac/hubtel-payment

A comprehensive PHP Package for consuming the Hubtel Payment API

v2.0.3 2018-04-02 07:00 UTC

README

687474703a2f2f7265732e636c6f7564696e6172792e636f6d2f6f7661632f696d6167652f75706c6f61642f685f3230302f76313530363832343534342f34615f557737725f6c6a796271332e6a7067 687474703a2f2f7265732e636c6f7564696e6172792e636f6d2f6f7661632f696d6167652f75706c6f61642f685f3132302f76313530363832383738362f6c6f676f2d636f6d706f7365722d7472616e73706172656e745f7a6a67616c302e706e67 687474703a2f2f7265732e636c6f7564696e6172792e636f6d2f6f7661632f696d6167652f75706c6f61642f685f3230302f76313530363832383036332f6272616e645f70626d736a6b2e676966
687474703a2f2f7265732e636c6f7564696e6172792e636f6d2f6f7661632f696d6167652f75706c6f61642f76313530363832383338302f6c6f676f5f73697a655f696e766572745f6a656c6837342e6a7067

OVAC Hubtel Payment

The best and most comphrensive PHP Client for consuming the Hubtel Payment API and for sending and receiving Mobile Money Payment from a php application with an elegant Write as it sounds syntax.

Build Status Coverage Status Latest Stable Version Total Downloads License Dependency Status

 Follow me anywhere @ovac4u                         | GitHub
 _________                          _________       | Twitter
|   ___   |.-----.--.--.---.-.----.|  |  |.--.--.   | Facboook
|  |  _   ||  _  |  |  |  _  |  __||__    |  |  |   | Instagram
|  |______||_____|\___/|___._|____|   |__||_____|   | Github + @ovac
|_________|                        www.ovac4u.com   | Facebook + @ovacposts

What is it?

OVAC/Hubtel-Payment is a comphrensive PHP client for consuming the Hubtel Mobile Money Payment server API. It's a full-on PHP toolbet sugar-coated by an elegant syntax directly inspired by the Laravel framework.

It features a good set of methods and tests for accessing the Hubtel Mobile Money Payment with a Write as it sounds syntax. Oh also it is growing all the time.

What's the cherry on top? It wraps nicely around native Guzzlehttp client and uses most of PHP best practices in relation to usability and security. What does this mean? This means that Pay::receiveMoney()->from(0553577261)->run(); actually places a dynamic call behind the scene in a very secure manner using the phone number as the Customer's idn as required by the Hubtel's Mobile Money Receive Money api and prompts the owner of the phone number as an agent.

Install OVAC\Hubtel-Payment

To install OVAC\HubtelPayment library, simply run

$ composer require ovac/hubtel-payment

OVAC\Hubtel-Payment Basic Usage

First Obtain a Hubtel Developer Account Number, ClientID and ClientSecret from https://unity.hubtel.com/account/api-accounts-add

The ReceiveMoney class may be used to send a prompt to the customer's phone to receive money like a mobile-money agent as follows:

<?php
require_once __DIR__ . '/vendor/autoload.php';

use OVAC\HubtelPayment\Config;
use OVAC\HubtelPayment\Api\Transaction\ReceiveMoney;

// First Create configuration with your Hubtel Developer Credentials
// The Account Number, ClientID and ClientSecret accordingly.
$config = new Config(Account_Nnumber, ClientId, ClientSecret);

$payment =  ReceiveMoney::from('0553577261')          //- The phone number to send the prompt to.
                ->amount(100.00)                    //- The exact amount value of the transaction
                ->description('Online Purchase')    //- Description of the transaction.
                ->customerName('Ariama Victor')     //- Name of the person making the payment.
                ->callback('http://ovac4u.com/pay') //- The URL to send callback after payment.	
                ->channel('mtn-gh')                 //- The mobile network Channel.
                ->injectConfig($config)             //- Inject the configuration
                ->run();                            //- Run the transaction after required data.

The SendMoney class may also be used to send money to any mobile money customer as follows:

<?php
require_once __DIR__ . '/vendor/autoload.php';

use OVAC\HubtelPayment\Config;
use OVAC\HubtelPayment\Api\Transaction\SendMoney;

// First Create configuration with your Hubtel Developer Credentials
// The Account Number, ClientID and ClientSecret accordingly.
$config = new Config(Account_Nnumber, ClientId, ClientSecret);

$payment = SendMoney::to('0553577261')                //- The phone number to send the prompt to.
                ->amount(100.00)                    //- The exact amount value of the transaction
                ->description('Online Purchase')    //- Description of the transaction.
                ->customerEmail('admin@ovac4u.com') //- Name of the person making the payment.
                ->callback('http://ovac4u.com/pay') //- The URL to send callback after payment.	
                ->channel('mtn-gh')                 //- The mobile network Channel.
                ->injectConfig($config)             //- Inject the configuration
                ->run();                            //- Run the transaction after required data.

The Refund class may also refund money a customer paid in a previous transaction:

<?php
require_once __DIR__ . '/vendor/autoload.php';

use OVAC\HubtelPayment\Config;
use OVAC\HubtelPayment\Api\Transaction\Refund;

// First Create configuration with your Hubtel Developer Credentials
// The Account Number, ClientID and ClientSecret accordingly.
$config = new Config(Account_Nnumber, ClientId, ClientSecret);

$payment = Refund::transactionId(1234)              //- The ID of the transaction to refund.
                ->amount(100.00)                    //- The exact amount value of the transaction
                ->clientReference('#11212')         //- A refeerence on your end.
                ->description('Useless Purchase')   //- Description of the transaction.
                ->reason('No longer needs a pen')   //- Name of the person making the payment.
                ->full()                            //- Full or partial refund.
                ->injectConfig($config)             //- Inject the configuration
                ->run();                            //- Run the transaction after required data.

Documentation

You can find a detailed summary of all classes and methods on the official page. The changelog is available in the CHANGELOG file.

You can find a detailed summary of all classes and methods in the repo's wiki or the official page. The changelog is available in the CHANGELOG file.

Tests

if you have phpunit installed globally

$ vendor/bin/phpunit

or use the composer script

$ composer phpunit

Code analysis tools

lint/checkstyle with phpcs:

$ composer phpcs

mess detector with phpmd:

$ composer phpmd

copy & paste detector with phpcpd:

$ composer phpcpd

phpunit, lint, mess detector in one command:

$ composer test

CI

A simple ci bash script exists under bin folder

$ bin/ci.sh

Contributing

Thank you for considering contributing to Laravel Hackathon Starter. The contribution guide can be found in the Contribution File

Security

If you discover any security related issues, please email instead of using the issue tracker.

Credits

Licence

Reference

How can I thank you?

Why not star the github repo? I'd love the attention! Why not share the link for this repository on Twitter or HackerNews? Spread the word!

Don't forget to follow me on instagram and twitter

Thanks! Ariama Victor (ovac4u).