Developer’s API

Paytev Simple API Documentation

Balance API
----------------------------
METHOD: GET
https://client.paytev.com/api/v1/balance?format=json&api-token=xxxxxxx
Example:
https://client.paytev.com/api/v1/balance?format=json&api-token=API_TOKEN

Response Codes:
Success: {"status":200,"message":"success","balance":223900.0}
Failed: {'status': 400, 'message':'error', 'details': 'Bad Request Check Your Parameters'}
End of Balance API

Airtime API
--------------------------- 
METHOD: POST
https://client.paytev.com/api/v1/airtime?format=json&phone=XXXXXXX&amount=XXXX&network=XXXXX
Example:
https://client.paytev.com/api/v1/airtime?format=json&phone=08144216361&amount=100&network=mtn_airtime

HEADERS
Authorization: 903a4a41b60c3cd8be0e2d76fac3f9180823d782
source-domain: https://google.com

Parameters: 
format: json
api-token: 903a4a41b60c3cd8be0e2d76fac3f9180823d782
phone: 08144216361
amount: 100
network: mtn_airtime

newtwork = network code E.g "mtn_airtime" "glo_airtime"
"mtn_airtime" for MTN Airtime TopUp
"glo_airtime" for Glo Airtime TopUp
"airtel_airtime" for Airtel Airtime TopUp
"9mobile_airtime" for 9mobile Airtime TopUp
phone = Recipient Number to top-up and must start with zero e.g 08144216361
amount = Amount to Recharge. E.g 100,500, 1000 etc

Response Codes:
Success: {'status':201, 'message':'success', 'details': 'Transaction Submitted'}
Failed: {'status':'403', 'message': 'Update your profile to proceed'}
{'status':205, 'message':'failure', 'details': 'Transaction not Successful'}
{'status': 422, 'message':'error', 'details':'Insufficient Balance'}
{'status': 400, 'message':'error', 'details': 'Bad Request Check Your Parameters'}
End of Airtime API

Data API
-----------------------
METHOD: POST
https://client.paytev.com/api/v1/data?format=json&phone=08163524890&network=waec_airtime&amount=500MB_(SME)
Example: https://client.paytev.com/api/v1/data?format=json&api-token=XXXXX&network=mtn_sme_data&phone=08144216361&amount=M500MBS
The above requested for MTN SME Data to Recipient Number 08144216361 and data amount is 500MB

HEADERS
Authorization: 903a4a41b60c3cd8be0e2d76fac3f9180823d782 
source-domain: https://google.com 

Parameters:
format: json
api-token: API_TOKEN
phone: 08144216361
authorization: 903a4a41b60c3cd8be0e2d76fac3f9180823d782
network: mtn_sme_data
amount: M500MBS


newtwork = network code E.g "mtn_sme_data" "airtel_data"
"mtn_gifting_data" for MTN Gifting Data Bundles
"mtn_sme_data" for MTN SME Data Bundles
"glo_data" for Glo Data Bundles
"airtel_data" for Airtel Data Bundles
"9mobile_data" for 9mobile Data Bundles 
phone = Recipient Number and must start with zero E.g 08144216361
amount = Data unique ID. E.g "M1GBG" "M2GBG" "M3GBG" etc

Response Codes:
Success: {'status':201, 'message':'success', 'details': 'Transaction Submitted'}
Failed: {'status':'403', 'message': 'Update your profile to proceed'}
{'status':205, 'message':'failure', 'details': 'Transaction not Successful'}
{'status': 422, 'message':'error', 'details':'Insufficient Balance'}
{'status': 400, 'message':'error', 'details': 'Bad Request Check Your Parameters'}
End of Data API

Cable Decoder API
METHOD: GET
Decoder Customer Check
https://client.paytev.com/api/v1/check-cable-customer?format=json&smart_no=4131953321&service=dstv

HEADERS 
Authorization: 903a4a41b60c3cd8be0e2d76fac3f9180823d782 
source-domain: https://google.com 

Parameters: 
format: json
api-token: API_TOKEN
smart_no: 4131953321
service: dstv

smart_no = Customer IUC number
service = dstv/gotv/startimes

Responses: 
Success: {"customer_name":"ESU INI OBONG BASSEY","smart_no":"4131953321","status":"OPEN","customer_number":"275953782","invoice":"1","expire_on":"13-11-2019","service":"dstv"}
Failed: {'status':'403', 'message': 'Update your profile to proceed'}
{ 'status': 422, 'message':'error', 'details':'invalid entries'}

Decoder Customer Subscription
METHOD: POST
https://client.paytev.com/api/api/v1/cable?format=json&smart_no=4131953321&service=dstv&phone=08181882222&customer_name=INI OBONG BASSEY ESU&customer_number=275953782&invoice=1&plan_code=dstv-padi

HEADERS 
Authorization: 903a4a41b60c3cd8be0e2d76fac3f9180823d782 
source-domain: https://google.com

 
Parameters:
format: json
smart_no: 4131953321
service: dstv
phone: 08181882222
customer_name: INI OBONG BASSEY ESU
customer_number: 275953782
invoice: 1
plan_code: dstv-padi


smart_no = Customer IUC number
service = dstv/gotv/startimes (identifier)
phone = phone
customer_name = Customer name from check API
customer_number = Customer number from check API
invoice = Invoice from check API
plan_code = Go check up there for plan codes 


Responses:
Success: {'status':201, 'message':'success', 'details': 'Transaction Submitted'}
Failed: {'status':205, 'message':'failure', 'details': 'Transaction Not Successful'}
{'status':400, 'message':'error', 'details':'Insufficient Balance'}
{'status':400, 'message':'Bad Request', 'details':' Bad Request check your paramaters'}
End of Cable Decoder API