Service ID API

This section contains the recommended flow for getting the available service IDs 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 ID

Using a GET method, the VTpass service IDs for Data [for instance] can be accessed with the endpoint below:

Live:   https://vtpass.com/api/services?identifier=data

Sandbox: https://sandbox.vtpass.com/api/services?identifier=data

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

 

EXPECTED RESPONSE

{  
   "response_description":"000",
   "content":{
       {
            "serviceID": "airtel-data",
            "name": "Airtel Data",
            "minimium_amount": "1",
            "maximum_amount": 1000000,
            "convinience_fee": "0 %",
            "product_type": "fix",
            "image": "https://vtpass.com/resources/products/200X200/Airtel-Data.jpg"
        },
        {
            "serviceID": "mtn-data",
            "name": "MTN Data",
            "minimium_amount": "1",
            "maximum_amount": 1000000,
            "convinience_fee": "0 %",
            "product_type": "fix",
            "image": "https://vtpass.com/resources/products/200X200/MTN-Data.jpg"
        },
        ...
}

 

NOTE: Identifiers are gotten from this endpoint