GLO SME Data Subscription API

This section contains the recommended flow for integrating GLO SME Data Subscription services on the VTpass RESTful API.

Authentication

Learn about authentication from here.

Available Endpoints

To integrate the VTpass GLO SME Data Subscription Payment RESTful API, the endpoints below applies:

  • Get Variation Codes: this returns variation codes for various GLO SME Data (subscription plans)
  • Purchase Product (Using the variation code gotten in the first step)
  • Query transaction status

 

GET VARIATION CODES

Using a GET method, the VTpass variation codes for GLO SME Data subscription plans can be accessed with the endpoint below:

Live:   https://vtpass.com/api/service-variations?serviceID=glo-sme-data

Sandbox: https://sandbox.vtpass.com/api/service-variations?serviceID=glo-sme-data

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

 

 

EXPECTED RESPONSE

{
   "response_description":"000",
   "content":{
      "ServiceName":"GLO Data SME",
      "serviceID":"GLO-sme-data",
      "convinience_fee":"0 %",
      "varations":[
         {
            "variation_code": "glo-dg-50",
            "name": "Glo Data (SME) N50 - 200MB - 14 days",
            "variation_amount": "50.00",
            "fixedPrice": "Yes"
         },
         {
             "variation_code": "glo-dg-125-14",
             "name": "Glo Data (SME) N125 - 500MB 14 days",
             "variation_amount": "125.00",
             "fixedPrice": "Yes"
         },
         {
             "variation_code": "glo-dg-125-30",
             "name": "Glo Data (SME) N125 - 500MB 30 days",
             "variation_amount": "125.00",
             "fixedPrice": "Yes"
         },
          ...
      ]
   }
}

PURCHASE PRODUCT

Using a POST method, GLO SME Data bundle can be purchased with the endpoint below:  

Live: https://vtpass.com/api/pay

Sandbox: https://sandbox.vtpass.com/api/pay

ServiceID: glo-sme-data

 

The sandbox environment provides specific scenarios to simulate success, failure, or unexpected outcomes for data purchases. Use the examples below to test and observe how your integration behaves.

Refer to the table below to find the correct phone number for simulating various API responses:

Phone Number  Event Description
08011111111 Successful  Returns a successful response for testing data purchases.
201000000000 Pending Simulates an unexpected pending response.
500000000000 Unexpected Response Simulates an expected response, used to test how your system handles anomalies.
400000000000 No Response Simulates a scenario where the API returns no response.
300000000000 Timeout Simulates a timeout scenario for testing response handling under delays.
Any random phone number other than the above Failed Simulates a failed scenario for testing error handling for transaction failure.

 

NEEDED PAYLOAD

FIELDS Mandatory/Optional TYPE DESCRIPTION
request_id M String This is a unique reference with which you can use to identify and query the status of a given transaction after the transaction has been executed. Click here to understand how to generate a valid request ID
serviceID M String Service ID as specified by VTpass. In this case, it is glo-sme-data
billersCode M String The phone number you wish to make the Subscription payment on
variation_code M String The code of the variation (as specified in the GET VARIATIONS method as variation_code).
amount O Number The amount of the variation (as specified in the GET VARIATIONS endpoint as variation_amount) This amount will be ignored as the variation code determine the price of the data bundle.
phone M Number The phone number of the customer or recipient of this service

 

EXPECTED RESPONSE

{
  "code": "000",
  "content": {
      "transactions": {
         "status": "delivered",
         "product_name": "GLO SME Data",
         "unique_element": "08011111111",
         "unit_price": 250,
         "quantity": 1,
         "service_verification": null,
         "channel": "api",
         "commission": 10,
         "total_amount": 240,
         "discount": null,
         "type": "Data Services",
         "email": "sandbox@vtpass.com",
         "phone": "08090909090",
         "name": null,
         "convinience_fee": 0,
         "amount": 250,
         "platform": "api",
         "method": "api",
         "transactionId": "17200941890118844651277713"
       }
    },
    "response_description": "TRANSACTION SUCCESSFUL",
    "requestId": "202407041252_200989s87dssdsdedsss",
    "amount": "250.00",
    "transaction_date": {
        "date": "2024-07-04 12:56:29.000000",
        "timezone_type": 3,
        "timezone": "Africa/Lagos"
     },
     "purchased_code": ""
}

QUERY TRANSACTION STATUS

Using a POST method, transaction status can be queried with the endpoint below:

Live: https://vtpass.com/api/requery

Sandbox: https://sandbox.vtpass.com/api/requery

FIELDS Mandatory/Optional TYPE DESCRIPTION
request_id M String
This is the reference with which you sent when purchasing a transaction after the transaction has been executed.

 

EXPECTED RESPONSE

{
  "code": "000",
  "content": {
      "transactions": {
         "status": "delivered",
         "product_name": "GLO SME Data",
         "unique_element": "08011111111",
         "unit_price": 250,
         "quantity": 1,
         "service_verification": null,
         "channel": "api",
         "commission": 10,
         "total_amount": 240,
         "discount": null,
         "type": "Data Services",
         "email": "sandbox@vtpass.com",
         "phone": "08090909090",
         "name": null,
         "convinience_fee": 0,
         "amount": 250,
         "platform": "api",
         "method": "api",
         "transactionId": "1582290782154"
       }
    },
    "response_description": "TRANSACTION SUCCESSFUL",
    "requestId": "202407041252_200989s87dssdsdedsss",
    "amount": "250.00",
    "transaction_date": {
        "date": "2024-07-04 12:56:29.000000",
        "timezone_type": 3,
        "timezone": "Africa/Lagos"
     },
     "purchased_code": ""
}

You can check out the complete list of RESPONSE CODES HERE.