Skip to content

How to Get a VTU API for Your Business in Nigeria

How to Get a VTU API for Your Business in Nigeria
How to Get a VTU API for Your Business in Nigeria

How to Get a VTU API for Your Business in Nigeria

If you run a VTU business, fintech platform, recharge website, mobile app or digital payment service, you may eventually need an API that allows your platform to process data, airtime and other bill payments automatically.

Instead of manually processing every transaction, a VTU API can connect your website or application to a service provider and allow your customers to purchase services directly from your platform.

For businesses in Nigeria, Inlomax provides a REST API that supports services such as data, airtime, cable TV subscriptions, electricity payments and education pins.

What Is a VTU API?

A VTU API is a software connection between your application and a VTU service provider.

For example, imagine that you operate a website where customers can buy MTN data.

Without an API, you may have to receive the customer’s payment and manually process the data purchase.

With an API, your website can send the transaction request automatically to your VTU provider. The provider processes the transaction and sends a response back to your system.

This allows you to build features such as:

  • Data purchases
  • Airtime recharge
  • DStv and GOtv subscriptions
  • Electricity bill payments
  • Examination PIN sales
  • Transaction status checking
  • Automated customer notifications
  • Wallet-based transactions

Why Does a VTU Business Need an API?

An API becomes particularly useful when you want to move beyond manually processing transactions.

For example, you can build a website where customers:

  1. Create an account.
  2. Fund their wallet.
  3. Select a service.
  4. Enter their phone number or customer details.
  5. Confirm the transaction.
  6. Receive the service automatically.

Your platform communicates with the VTU provider in the background.

This can reduce manual work and make it possible to handle more transactions as your customer base grows.

How to Get a VTU API From Inlomax

Inlomax provides API documentation for developers and uses an API key for authentication. According to its official documentation, you need to log in to your account to obtain your API key.

Here is the basic process.

1. Create an Inlomax Account

Start by creating an Inlomax account.

The platform currently allows users to create an account and fund their wallet before transacting.

You can also use the Inlomax mobile app if you prefer managing your account from your phone.

iPhone: Download Inlomax on the App Store

Android: Download Inlomax on Google Play

2. Log In to Your Account

After creating your account, log in to the Inlomax dashboard.

The API documentation states that an API key is required for authentication and that you need to log in to obtain your key.

3. Get Your API Key

After logging in, access the API/developer section of your account and obtain your API key.

Keep your API key private.

Do not place your secret API key directly inside publicly accessible frontend JavaScript or expose it in your GitHub repository.

Your backend should handle API requests securely.

4. Read the API Documentation

Before integrating anything, go through the API documentation.

Inlomax currently provides documentation for:

  • Balance
  • Service details
  • Airtime
  • Data
  • Utility payments
  • Electricity
  • Education PINs
  • Webhooks
  • Service IDs

It also provides live and sandbox API environments.

Inlomax VTU API Endpoints

The live API uses the following general structure:

https://inlomax.com/api/{endpoint}

The documentation also provides a sandbox environment for testing:

https://inlomax.com/sandbox/{endpoint}

This gives developers the ability to work with the API while building their applications.

What Can You Sell Through a VTU API?

The services available depend on the provider and your integration.

Inlomax currently documents API support for several services.

Data

The data endpoint can be used to purchase data for supported networks.

The official documentation provides a data endpoint at /api/data and uses an API token in the authorization header.

Inlomax’s current pricing page lists API prices for data plans across networks including MTN, Airtel, Glo and 9mobile.

Airtime

You can also integrate airtime purchases into your website or application.

The documented airtime endpoint is:

https://inlomax.com/api/airtime

The request uses an API key and includes information such as the service ID, amount and customer’s mobile number.

Electricity

A VTU platform can also integrate electricity payments so customers can purchase electricity through your application.

Inlomax currently lists API discounts for supported Nigerian electricity distribution companies, including AEDC, IKEDC, EKEDC, IBEDC, PHED and others.

Cable TV

Cable subscription is another service that can be integrated into a VTU platform.

The Inlomax API documentation identifies cable subscriptions as one of the services supported by its API.

Examination Pins

Education services can also be integrated.

For example, the Inlomax education endpoint can process examination-pin purchases, with the API response returning information such as the PIN and serial number for successful purchases.

How API Authentication Works

When your application sends a request to the API, it needs to prove that the request is coming from an authorised account.

Inlomax uses an API key for authentication. Its documented requests use an authorization header similar to:

Authorization: Token YOUR_API_KEY

The exact implementation should follow the current API documentation rather than copying credentials into your application code.

You Need a Backend for Secure Integration

One common mistake beginners make is putting their API key directly into their website’s frontend code.

For example, if your website uses JavaScript in the browser to communicate directly with the VTU provider, visitors may potentially inspect the code and obtain credentials that should remain private.

A better structure is:

Customer → Your Website/App → Your Backend → VTU API → Your Backend → Customer

Your backend keeps the API key private and handles communication with the VTU provider.

You can build the backend using technologies such as:

  • PHP
  • Python
  • Node.js
  • Laravel
  • Other server-side frameworks

Inlomax also states that it provides official SDK libraries for PHP and Python to help developers integrate more easily.

Add Transaction Status Handling

A good VTU platform should not assume that every API request immediately succeeds.

Inlomax documents three main transaction statuses:

  • Success — the transaction was completed.
  • Processing — the transaction is still being processed.
  • Failed — the transaction could not be completed.

The documentation also states that failed transactions are automatically reversed or refunded if payment was deducted.

Your own platform should therefore be designed to handle these different responses instead of displaying every request as successful.

Use Webhooks for Automatic Updates

Webhooks can help your system receive transaction updates without constantly checking the API manually.

For example, your application could receive an update when a transaction changes from processing to successful.

Inlomax lists webhook documentation as part of its API documentation, and its main website describes real-time transaction notifications as one of the API features.

This can be useful when building a professional VTU platform where customers need accurate transaction updates.

Check API Pricing Before Launching

Before launching your VTU business, check the provider’s current API prices.

Inlomax’s pricing page separates User Price, Reseller Price and API Price for many services. For example, the current page lists different API prices for several MTN and Airtel data plans.

Your profit margin will depend on factors such as:

  • API purchase price
  • Your selling price
  • Payment processing costs
  • Server costs
  • Customer support
  • Failed transaction handling
  • Promotions or discounts

Don’t simply copy another VTU platform’s selling price without calculating your own costs.

Test Before Going Live

If you are building a new VTU website or application, don’t immediately launch it to customers.

Test important scenarios first.

For example:

  1. Successful data transaction.
  2. Successful airtime transaction.
  3. Failed transaction.
  4. Processing transaction.
  5. Insufficient wallet balance.
  6. Invalid customer details.
  7. Duplicate transaction request.
  8. API timeout.
  9. Webhook response.
  10. Transaction reversal.

Testing these situations can help prevent customers from being charged incorrectly.

Keep Your API Key Secure

Your API key should be treated like a password.

Avoid:

  • Posting it on WhatsApp groups.
  • Uploading it to GitHub.
  • Putting it inside frontend JavaScript.
  • Sharing it with customers.
  • Hard-coding it into publicly accessible files.

If you believe your API key has been exposed, follow the provider’s security procedure and replace or revoke the affected credential where supported.

Can You Build Your Own VTU Website With an API?

Yes. A developer can build a complete VTU platform around an API.

For example, your system could include:

  • Customer registration
  • Login
  • Wallet funding
  • Data purchase
  • Airtime purchase
  • TV subscription
  • Electricity payment
  • Exam PIN purchase
  • Transaction history
  • Automated receipts
  • Admin dashboard
  • API transaction logs
  • Referral system
  • Reseller accounts

The API provides the connection to the underlying services, while your application controls the customer-facing experience.

Final Thoughts

Getting a VTU API for your business is a practical step if you want to automate data, airtime and bill-payment transactions on your website or mobile application.

With Inlomax, developers can create an account, log in to obtain an API key, review the API documentation and integrate the available services into their applications. The platform provides live and sandbox API environments as well as PHP and Python SDK support.

If you’re just starting out, you can also manage your VTU activities through the Inlomax mobile app before moving into a full API integration.

iPhone: Download Inlomax on the App Store

Android: Download Inlomax on Google Play

For developers, the official Inlomax API documentation is the best place to check the current endpoints, authentication requirements and integration details.

Leave a Reply

Your email address will not be published. Required fields are marked *