emmadedayo/laravel-vtpass

Maintainers

Details

github.com/emmadedayo/laravel-vtpass

Homepage

Source

Issues

Installs: 330

Dependents: 0

Suggesters: 0

Security: 0

Stars: 15

Watchers: 1

Forks: 3

Open Issues: 0

pkg:composer/emmadedayo/laravel-vtpass

1.0.1 2022-03-13 22:42 UTC

Requires

Requires (Dev)

MIT f618b8f27bdaff1911476c87c2424397164781f7

  • Adenagbe Emmanuel <emmadenagbe.woop@gmail.com>

phpNigeriabillsvtuVtpassairtime top up

This package is not auto-updated.

Last update: 2025-11-03 16:31:03 UTC

README

This is where your description should go. Take a look at contributing.md to see a to do list.

## Installation

Via Composer

$ composer require emmadedayo/laravel-vtpass

Setup

The package will automatically register a service provider.

You need to publish the configuration file:

php artisan vendor:publish --provider="Emmadedayo\VtPass\VTPassServiceProvider"

This is the default content of the config file vtpass.php:

<?php

return [
  "username"          => env("VTPASS_USERNAME"),
  "password"          => env("VTPASS_PASSWORD"),
  // specify to use sandbox mode or live mode
   "mode"              => env("VTPASS_MODE", "sandbox"), // app mode sandbox ?? live
];

Update Your Projects .env with:

VTPASS_USERNAME=xxx@xxxx.com
VTPASS_PASSWORD=xxxxxx
VTPASS_MODE=sandbox //leave at sandbox for testing purpose

Available Api's Model

Emmadedayo\VtPass\Model\VTClassicPurchase;
Emmadedayo\VtPass\Model\VTModernPurchase;

Explicit Usage

Get Service and Variational Code (Modern Model and Classic Ways)

use Emmadedayo\VtPass\Model\MobileAirtime;

public function loadData(){
 
  VTModernPurchase::getServiceID([
      'identifier'=>'tv-subscription'
  ]); 
  
  VTModernPurchase::variations([
      'serviceID'=>'gotv'
  ]); 
  
  VTModernPurchase::category();
  
  VTModernPurchase::getProductOptions([
        'serviceID'=>'aero',
        'name'=>'passenger_type'
  ]);  
  
}

Buying Airtime in (Modern Model Way)

use Emmadedayo\VtPass\Model\MobileAirtime;

public function buyAirtime(){ 
  $serviceID = 'mtn';
  $phone = '08011111111'; //demo phone number
  $amount = 100;
  $requestID = rand(1000,9000); //save your request id for re-query and verification purpose(optional)

  $result =  VTModernPurchase::purchase([
    'serviceID'   => $serviceID,
    'phone'       => $phone,
    'amount'      => $amount,
  ]);
  
  return Response::json($result);
  
}

Response

{
    "code": "000",
    "content": {
        "transactions": {
            "status": "delivered",
            "product_name": "MTN Airtime VTU",
            "unique_element": "08011111111",
            "unit_price": 100,
            "quantity": 1,
            "service_verification": null,
            "channel": "api",
            "commission": 4,
            "total_amount": 96.5,
            "discount": null,
            "type": "Airtime Recharge",
            "email": "emmanzley@yahoo.com",
            "phone": "08103141424",
            "name": null,
            "convinience_fee": 0,
            "amount": 100,
            "platform": "api",
            "method": "api",
            "transactionId": "16397074258999566580332982"
        }
    },
    "response_description": "TRANSACTION SUCCESSFUL",
    "requestId": "123255",
    "amount": "100.00",
    "transaction_date": {
        "date": "2021-12-17 03:17:05.000000",
        "timezone_type": 3,
        "timezone": "Africa/Lagos"
    },
    "purchased_code": ""
}

Status

VTModernPurchase::status([
  'request_id' => '24545544'
]);

Response

{
    "code": "000",
    "content": {
        "transactions": {
            "status": "delivered",
            "product_name": "MTN Airtime VTU",
            "unique_element": "08011111111",
            "unit_price": 100,
            "quantity": 1,
            "service_verification": null,
            "channel": "api",
            "commission": 4,
            "total_amount": 96.5,
            "discount": null,
            "type": "Airtime Recharge",
            "email": "emmanzley@yahoo.com",
            "phone": "08103141424",
            "name": null,
            "convinience_fee": 0,
            "amount": 100,
            "platform": "api",
            "method": "api",
            "transactionId": "16397074258999566580332982"
        }
    },
    "response_description": "TRANSACTION SUCCESSFUL",
    "requestId": "123255",
    "amount": "100.00",
    "transaction_date": {
        "date": "2021-12-17 03:17:05.000000",
        "timezone_type": 3,
        "timezone": "Africa/Lagos"
    },
    "purchased_code": ""
}

Buying Data in (Classic Model Way)

use Emmadedayo\VtPass\Model\MobileData;

public function buyData(){ 

    $requestID = rand(1000,9000); //save your request id for re-query and verification purpose(optional)
    $serviceID = 'mtn-data';
    $billersCode = '08011111111';
    $variationCode = "mtn-10mb-100";
    $phone = '08011111111';
    $amount = 100;
    
     $result =  VTClassicPurchase::purchaseData($requestID,$serviceID,$billersCode,$variationCode,$amount,$phone);
     return Response::json($result);
      
}

Response

{
    "code": "000",
    "content": {
        "transactions": {
            "status": "delivered",
            "product_name": "MTN Data",
            "unique_element": "08011111111",
            "unit_price": 100,
            "quantity": 1,
            "service_verification": null,
            "channel": "api",
            "commission": 4,
            "total_amount": 96,
            "discount": null,
            "type": "Data Services",
            "email": "emmanzley@yahoo.com",
            "phone": "08103141424",
            "name": null,
            "convinience_fee": 0,
            "amount": 100,
            "platform": "api",
            "method": "api",
            "transactionId": "16397076684791728393807589"
        }
    },
    "response_description": "TRANSACTION SUCCESSFUL",
    "requestId": "09092109",
    "amount": "100.00",
    "transaction_date": {
        "date": "2021-12-17 03:21:08.000000",
        "timezone_type": 3,
        "timezone": "Africa/Lagos"
    },
    "purchased_code": ""
}

Status

MobileData::status([
  'request_id' => '24545544'
]);

Response

{
    "code": "000",
    "content": {
        "transactions": {
            "status": "delivered",
            "product_name": "MTN Data",
            "unique_element": "08011111111",
            "unit_price": 100,
            "quantity": 1,
            "service_verification": null,
            "channel": "api",
            "commission": 4,
            "total_amount": 96,
            "discount": null,
            "type": "Data Services",
            "email": "emmanzley@yahoo.com",
            "phone": "08103141424",
            "name": null,
            "convinience_fee": 0,
            "amount": 100,
            "platform": "api",
            "method": "api",
            "transactionId": "16397076684791728393807589"
        }
    },
    "response_description": "TRANSACTION SUCCESSFUL",
    "requestId": "09092109",
    "amount": "100.00",
    "transaction_date": {
        "date": "2021-12-17 03:21:08.000000",
        "timezone_type": 3,
        "timezone": "Africa/Lagos"
    },
    "purchased_code": ""
}

Change log

Please see the changelog for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see contributing.md for details and a todolist.

Security

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

Credits

License

license. Please see the license file for more information.