Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ovac/hubtel-payment
🎉A comprehensive PHP Client Package for consuming the Hubtel Payment API
https://github.com/ovac/hubtel-payment
ghana hubtel hubtel-payment mess-detector mobile-money mtn mtnmobilemoney ovac ovac4u phpunit tests watchr
Last synced: 3 months ago
JSON representation
🎉A comprehensive PHP Client Package for consuming the Hubtel Payment API
- Host: GitHub
- URL: https://github.com/ovac/hubtel-payment
- Owner: ovac
- License: mit
- Created: 2017-08-07T21:16:18.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-27T21:51:10.000Z (almost 6 years ago)
- Last Synced: 2024-04-14T10:08:00.888Z (9 months ago)
- Topics: ghana, hubtel, hubtel-payment, mess-detector, mobile-money, mtn, mtnmobilemoney, ovac, ovac4u, phpunit, tests, watchr
- Language: PHP
- Homepage: https://www.ovac4u.com/hubtel-payment
- Size: 10.1 MB
- Stars: 14
- Watchers: 5
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
---
# 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.
[](https://travis-ci.org/ovac/hubtel-payment)
[](https://coveralls.io/github/ovac/hubtel-payment?branch=master)
[](https://packagist.org/packages/ovac/hubtel-payment)
[](https://packagist.org/packages/ovac/hubtel-payment)
[](https://packagist.org/packages/ovac/hubtel-payment)
[](https://www.versioneye.com/user/projects/598fccd8368b081653c84e2e)
```md
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](http://www.laravel.com).
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
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
amount(100.00) //- The exact amount value of the transaction
->description('Online Purchase') //- Description of the transaction.
->customerEmail('[email protected]') //- 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
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](https://www.ovac4u.com/hubtel-payment). 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](https://github.com/ovac/hubtel-payment/blob/master/CONTRIBUTING.md)
## Security
If you discover any security related issues, please email
instead of using the issue tracker.
## Credits
- [All contributors](https://github.com/ovac/hubtel-payment/graphs/contributors)
## Licence
* [Licence: MIT](https://github.com/ovac/hubtel-payment/licence)
## Reference
- [Official Page](https://www.ovac4u.com/hubtel-payment)
- [Official Repo: Github](https://www.github.com/ovac/hubtel-payment)
- [Hubtel Merchant Payment Reference](https://developers.hubtel.com/documentations/merchant-account-api)
- [Laravel framework](http://laravel.com)
- [LICENCE: MIT](https://github.com/ovac/hubtel-payment/blob/licence)
- [CHANGELOG](https://github.com/ovac/hubtel-payment/blob/master/CHANGELOG.md)
## 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](http://www.instagram.com/ovac4u) and [twitter](http://www.twitter.com/ovac4u)
Thanks!
Ariama Victor (ovac4u).