Cable TV API Integration

(Sandbox Environment) Register and Login on the Sandbox Website to get your Sandbox API Key for the Sandbox Integration Click Here

Welcome to the Cable TV API Sandbox Integration page. This guide will help you integrate our Sandbox Cable Tv API into your system.

On Sandbox environment the IUC number or ICU number you are subscribing cable tv for must be 1212121212 any other IUC number or ICU number that is not 1212121212 the cable tv subscription request will fail. For Showmax, phone number must be 08011111111.

Cable TV Subscription API Request cURL Init Sample


curl -X POST https://sandbox.vtunaija.com.ng/api/cablesub/ \ 

-H "Authorization: Token YOUR_API_KEY" \ 

-H "Content-Type: application/json" \ 

-d '{ 

    "cablename": "1", 

    "smart_card_number": "1212121212", 

    "cableplan": "3", 

    "request-id": "894703dap89dk8945" 
 
}'

Successful Cable TV Subscription API Response Example

This is an example of the response returned for a successful Cable TV subscription.


{ 

    "Status": "successful", 

    "status": "success", 

    "api_response": "TRANSACTTION SUCCESSFUL",

    "id": "78977865523", 

    "ident": "78977865523", 

    "plan_amount": "5800.00", 

    "transaction_internal_id": "4539" 
  
}

Failed Cable TV Subscription API Response Example

This is an example of the response returned for a failed Cable TV subscription.


{ 

    "Status": "failed", 

    "status": "fail", 

    "api_response": "Failed Cable TV subscription", 

    "id": "78977865523", 

    "ident": "78977865523", 

    "plan_amount": "0.00", 

    "transaction_internal_id": "4539" 
  
}

Processing Cable TV Subscription API Response Example

This is an example of the response returned for a pending Cable TV subscription.


{ 

    "Status": "processing", 

    "status": "processing", 

    "api_response": "Pending Cable TV Subcription, transaction pending",

    "id": "78977865523", 

    "ident": "78977865523", 

    "plan_amount": "5800.00", 

    "transaction_internal_id": "4539" 
          
}

Failed Cable TV Subscription API Response Example

This is an example of a failed API response caused by factors such as an insufficient wallet balance, an incorrect API key, missing POST fields and so on.


{ 

    "Status": "failed", 
 
    "status": "fail", 

    "message": "Insufficient wallet balance", 
         
              
}

Post Terms Defined and Interpreted

cablename: This identifies the specific cable tv provider for which the user is subscribing cable tv. The cablename post field is represented by the numbers 1, 2, 3, or 4: 1 indicates GOTV, 2 indicates DSTV, 3 indicates STARTIMES, and 4 indicates SHOWMAX. For the complete list of Sandbox Vtunaija Cable IDs and Plan IDs, check the API Documentation Page 1.

smart_card_number: This is the IUC number or ICU number or Phone Number of the Cable tv for which the user wants to subscribe. For Gotv or Dstv it is IUC number, While for Startimes it is ICU number, but for Showmax it is Phone number. On Sandbox environment the IUC or ICU number must be 1212121212 any other IUC or ICU number that is not 1212121212 the cable tv subcription request will fail. For Showmax, phone number must be 08011111111.

cableplan: This is the particular cable tv package that the user wants to buy. The different cable tv packages are represented by Plan IDs. For the complete list of Sandbox Vtunaija Network IDs and Plan IDs, check the API Documentation Page 1.

request-id: This is the unique ID you send as the Request ID.