VTPass Python SDK

This repository provides the VTPass Python SDK to interact with various services provided by VTPass. The SDK allows you to perform operations such as checking wallet balance, purchasing airtime, and subscribing to data services.

Prerequisites

• Python 3.7 or higher
• vtpass package
• python-dotenv package
• VTPass API Key
• VTPass Public Key
• VTPass Secret Key

Installation

First, clone the repository and navigate to the project directory:

git clone https://github.com/Abiorh001/vtpass-pythonsdk.git
cd vtpass-pythonsdk

Then, install the required packages or skipp if you have already installed the vtpass-python-sdk package:

pip install -r requirements.txt

Environment Variables

Create a .env file in the root of your project directory and add the following environment variables:

API_KEY=your_api_key
PUBLIC_KEY=your_public_key
SECRET_KEY=your_secret_key
TIMEZONE=Africa/Lagos
JSON_RESPONSE=False # Set to True to return JSON response which is useful 
Sandbox_URL=https://sandbox.vtpass.com/api
Live_URL=https://live.vtpass.com/api

Usage

Note

You have two different URLs: the sandbox URL for testing and the live URL for production. You can switch between the two by using sandbox_url for testing and live_url for production.

Setting JSON_RESPONSE in environment variable to True will return the JSON response, which is more advisable to use. You can set it to False to return the response in a human-readable format which contain only the response content.

Import Required Modules

from vtpass import vtPass
from airtime import vtpass_airtime
from dotenv import load_dotenv
import os
from airtime.schema import AirtimeSchema
from data_subscription.schema import DataSubscriptionSchema, VerifySmileEmailSchema
from data_subscription import vtpass_data_subscription
from vtpass.schema import (
    ServiceIdentifierSchema,
    ServiceIdVariationSchema,
    ProductOptionSchema,
    ServiceIdSchema,
)
from tv_subscriptions import vtpass_tv_subscription
from tv_subscriptions.schema import TVSubscriptionSchema
from electricity_payment.schema import VerifyMeterValueSchema, ElectricityPaymentSchema
from electricity_payment import vtpass_electricity_payment
from educational_payment import vtpass_educational_payment
from educational_payment.schema import EducationalPaymentSchema, VerifyJambProfileSchema, JambEducationalPaymentSchema
# Load environment variables from .env file
load_dotenv()

sandbox_url = os.getenv('Sandbox_URL')
live_url = os.getenv('Live_URL')

Get Wallet Balance

# Get wallet balance
balance = vtPass.get_credit_wallet_balance(sandbox_url)
print(balance)

Get Available Service Categories

# Get available service categories
service_categories = vtPass.get_available_service_categories(sandbox_url)
try:
    # If JSON response is False
    for category in service_categories:
        print(f"Identifier: {category.get('identifier')}, Name: {category.get('name')}")
except Exception:
    # If JSON response is True
    print(service_categories)

Get Available Service Details

# Get available service details
identifier = ServiceIdentifierSchema(identifier="insurance")
service_details = vtPass.get_service_identify_details(sandbox_url, identifier)
try:
    # If JSON response is False
    for detail in service_details:
        print(f"Service Id: {detail.get('serviceID')}, Name: {detail.get('name')}")
except Exception:
    # If JSON response is True
    print(service_details)

Get Service Variation Details

# Get service variation details
service_id = ServiceIdVariationSchema(service_id="airtel-data")
service_variation_details = vtPass.get_service_variation_details(sandbox_url, service_id)
print(service_variation_details)

Get Product Options

# Get product options
product_option_schema = ProductOptionSchema(
    service_id="ui-insure",
    name="Third Party Motor Insurance - Universal Insurance"
)
service_product_options = vtPass.get_product_options(sandbox_url, product_option_schema)
print(service_product_options)

Generate Request ID

# Generate request ID
request_id = vtPass.generate_request_id()
print(request_id)

Purchase Airtime

# Purchase airtime
airtime_schema = AirtimeSchema(
    service_id="etisalat",
    phone_number="08011111111",
    amount=2000,
    request_id=request_id
)
purchase_airtime = vtpass_airtime.purchase_airtime(sandbox_url, airtime_schema=airtime_schema)
print(purchase_airtime)

Get Service Variation Code

# Get service variation code
service_id = ServiceIdSchema(service_id="spectranet")
service_variation_code = vtPass.get_service_variation_codes(sandbox_url, service_id)
print(service_variation_code)

Verify Smile Email Address

# Verify Smile email address
verify_smile_schema = VerifySmileEmailSchema(
    billers_code="tester@sandbox.com",
    service_id="smile-direct"
)
vtpass_smile_email_verify = vtpass_data_subscription.verify_smile_email(sandbox_url, verify_smile_schema)
print(vtpass_smile_email_verify)

Buy Data Subscription

# Buy data subscription
data_sub_schema = DataSubscriptionSchema(
    service_id="spectranet",
    variation_code="vt-5000",
    request_id=request_id,
    phone="08011111111",
    billers_code="1212121212",
)
data_subscription = vtpass_data_subscription.purchase_data_susbscription(sandbox_url, data_sub_schema)
print(data_subscription)

Verify Meter Value

# Verify meter value
verify_meter_value = VerifyMeterValueSchema(
    service_id="ikeja-electric",
    type="postpaid",
    billers_code="1010101010101"
)
vtpass_verify_meter_value = vtpass_electricity_payment.verify_meter_value(sandbox_url, verify_meter_value)
print(vtpass_verify_meter_value)

Electricity Payment

# Electricity payment
electricity_payment_schema = ElectricityPaymentSchema(
    service_id="jos-electric",
    variation_code="postpaid",
    billers_code="1010101010101",
    amount=1000,
    request_id=request_id,
    phone="08011111111"
)
verify_meter_value = VerifyMeterValueSchema(
    service_id="jos-electric",
    type="postpaid",
    billers_code="1010101010101"
)
vtpass_verify_meter_value = vtpass_electricity_payment.verify_meter_value(sandbox_url, verify_meter_value)

if "error" in vtpass_verify_meter_value:
    print(vtpass_verify_meter_value)
    print("Meter number not verified")
else:
    electricity_payment = vtpass_electricity_payment.electricity_payment(sandbox_url, electricity_payment_schema)
    print(electricity_payment)

Verify JAMB Profile

# Verify JAMB profile
verify_jamb_schema = VerifyJambProfileSchema( 
    service_id="jamb",
    billers_code="0123456789",
    type="de",
)
vtpass_verify_jamb_profile = vtpass_educational_payment.verify_jamb_profile(sandbox_url, verify_jamb_schema)
print(vtpass_verify_jamb_profile)

JAMB Educational Payment

# JAMB educational payment
educational_payment_schema = JambEducationalPaymentSchema(
    service_id="jamb",
    variation_code="utme",
    billers_code="0123456789",
    request_id=request_id,
    phone="08011111111",
)
verify_jamb_schema = VerifyJambProfileSchema( 
    service_id="jamb",
    billers_code="0123456789",
    type="utme",
)
vtpass_verify_jamb_profile = vtpass_educational_payment.verify_jamb_profile(sandbox_url, verify_jamb_schema)
if "error" in vtpass_verify_jamb_profile:
    print(vtpass_verify_jamb_profile)
    print("JAMB profile not verified")
else:
    jamb_educational_payment = vtpass_educational_payment.jamb_educational_payment(sandbox_url, educational_payment_schema)
    print(jamb_educational_payment)

General Educational Payment

# General educational payment
educational_payment_schema = EducationalPaymentSchema(
    service_id="waec",
    variation_code="waecdirect",
    request_id=request_id,
    phone="08011111111",
    billers_code="0123456789",
    amount=1000,
    quantity=1
)
educational_payment = vtpass_educational_payment.educational_payment(sandbox_url, educational_payment_schema)
print(educational_payment)

Retrieve Transaction Status

# Define the request data
data = {
    "request_id": request_id
}

# Retrieve the transaction status and full details
transaction_status = vtPass.get_transaction_status(sandbox_url, data)
print(transaction_status)

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Please feel free to submit issues, fork the repository and send pull requests!

---

This README provides a comprehensive guide on how to use the VTPass Python SDK with detailed examples. You can also check the official documentation for more information.