Available Services API

This section contains the recommended flow for getting the available service categories on VTpass RESTful API.

 

Authentication

The VTpass API uses Basic Authentication.

It should be passed as a concatenated string like this

username:password

Please use the following details for authentication

Username: YourVtpassEmail

Password: YourPassword

Please create your authentication details by following the instructions here.

 

 

GET SERVICE CATEGORIES

Using a GET method, the VTpass service categories can be accessed with the endpoint below:

Live:   https://vtpass.com/api/service-categories

Sandbox: https://sandbox.vtpass.com/api/service-categories

FIELDS Mandatory/Optional TYPE DESCRIPTION
N/A N/A N/A N/A

 

EXPECTED RESPONSE

{
    "response_description": "000",
    "content": [
        {
            "identifier": "airtime",
            "name": "Airtime Recharge"
        },
        {
            "identifier": "data",
            "name": "Data Services"
        },
        {
            "identifier": "tv-subscription",
            "name": "TV Subscription"
        },
        {
            "identifier": "electricity-bill",
            "name": "Electricity Bill"
        },
        {
            "identifier": "education",
            "name": "Education"
        },
        {
            "identifier": "funds",
            "name": "Funds"
        },
        {
            "identifier": "events",
            "name": "Events"
        },
        {
            "identifier": "other-services",
            "name": "Other Merchants/Services"
        },
        {
            "identifier": "insurance",
            "name": "Insurance"
        }
    ]
}