henryejemuta/laravel-vtpass

A laravel package to seamlessly integrate VTPass RESTful API into your laravel application

0.1.1 2020-09-29 14:04 UTC

Requires

• php: ^7.2
• ext-json: *
• guzzlehttp/guzzle: ^7.0
• illuminate/support: ^7.0|^8.0

Requires (Dev)

• mockery/mockery: 1.*
• orchestra/testbench: 6.* || 5.*
• phpunit/phpunit: ^8.0.0

MIT

• Henry Ejemuta

• payment
• laravel
• airtime
• Nigeria
• data bundle
• Vtpass
• bill payment
• Utility Bills
• Cable Bills

README

A laravel package to seamlessly integrate VTPass api within your laravel application

What is VTPass

VTPass is a platform through which you can make convenient payment for your day to day services like Phone Airtime Recharge, Internet Data bundle subscription, Cable TV subscription such as DTSV, GOTV, Startimes, Electricity bills (PHCN) and many other services.

Create a VTPass Account Sign Up.

Look up VTPass API Documentation API Documentation.

Whitelist Products

Although you have access to all VTpass products, they are disabled by default. To start selling specific products, you must whitelist them first. Whitelisting allows you to activate only the products you intend to offer through your integration. Follow the steps below to whitelist your desired products and enable them for vending.

Steps on how to whitelist products:

• To whitelist products for:
  1. The live environment, go to your VTpass profile here.
  2. The Sandbox environment, go to your Sandbox profile here.
• Click on the Product Settings tab on your profile page.
• Check the products you would like to vend and click the submit button

Request API Access

Now that you have gone through the documentation and all necessary tests done on the test environment, you are almost ready to go live!

1. Create Live Account: The next step is to create a live account here.
2. Request Access: After creating a live account, you need to request API access by clicking here (you need to be logged in to your live account before you can access this).
3. Fill Form: Fill the form on the page and check the service(s) integrated. Note: You will be required to input the request ID of a successful integration.
4. Submit: Once done, click on submit.

Non-Laravel Usage

If you are using this package in a non-laravel project, or you need a framework agnostic usage of this package, using the vanilla php version php-vtpass-vtu is suggested.

Installation

You can install the package via composer:

composer require henryejemuta/laravel-vtpass

Publish VTPass configuration file, migrations as well as set default details in .env file:

php artisan vtpass:init

Usage

To use the VTPass package you must import the VTPass Facades with the import statement below; Other Classes import is based on your specific usage and would be highlighted in their corresponding sections.

...
use HenryEjemuta\LaravelVTPass\Facades\VTPass;
...

VTPass Facades Overview

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Bugs & Issues

If you notice any bug or issues with this package kindly create and issues here ISSUES

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Henry Ejemuta
• All Contributors

License

The MIT License (MIT). Please see License File for more information.