Paytev Simple API Documentation
With our ready-to-use and developer-friendly API, you can easily integrate with your website or app for FREE to start receiving payments in a breeze.
Paytev’s API allows you (developers) to integrate all virtual top-up (VTU) and bill payment services available on our platform with your application or websites. As an API user, you will enjoy even cheaper prices on all our services.
Airtime Plan Network Codes
Network Code | Network Name |
---|---|
mtn_airtime | MTN |
glo_airtime | GLO |
9mobile_airtime | 9MOBILE |
airtel_airtime | AIRTEL |
Data Plan Network Codes
Network Code | Network Name |
---|---|
mtn_gifting_data | MTN Gifting |
mtn_sme_data | MTN SME |
glo_data | GLO |
9mobile_data | 9mobile |
airtel_data | Airtel |
Data price list and data ID
Data ID | Network | Price | Size | Data Type | Validity |
---|---|---|---|---|---|
M500MBG | MTN | ₦118 | 500.0 MB | CG | 1 month |
M1GBG | MTN | ₦235 | 1.0 GB | CG | 1 month |
M2GBG | MTN | ₦470 | 2.0 GB | CG | 1 month |
M3GBG | MTN | ₦704 | 3.0 GB | CG | 1 month |
M5GBG | MTN | ₦1,175 | 5.0 GB | CG | 1 month |
M10GBG | MTN | ₦2,350 | 10.0 GB | CG | 1 month |
M15GBG | MTN | ₦3,525 | 15.0 GB | CG | 1 month |
M20GBG | MTN | ₦4,700 | 20.0 GB | CG | 1 month |
M40GBG | MTN | ₦9,400 | 40.0 GB | CG | 1 month |
M75GBG | MTN | ₦17,625 | 75.0 GB | CG | 1 month |
M100GBG | MTN | ₦23,500 | 100.0 GB | CG | 1 month |
M500MBS | MTN | ₦107 | 500 MB | SME | 1 month |
M1GBS | MTN | ₦214 | 1.0 GB | SME | 1 month |
M2GBS | MTN | ₦428 | 2.0 GB | SME | 1 month |
M3GBS | MTN | ₦642 | 3.0 GB | SME | 1 month |
M5GBS | MTN | ₦1070 | 5.0 GB | SME | 1 month |
M10GBS | MTN | ₦2140 | 10.0 GB | SME | 1 month |
G1GB | GLO | ₦450 | 1GB | CG | 14 days |
G2GB | GLO | ₦900 | 2.3GB | CG | 1 month |
G4GB | GLO | ₦1,340 | 3.85GB | CG | 1 month |
G5GB | GLO | ₦1,800 | 5.25GB | CG | 1 month |
G7GB | GLO | ₦2,250 | 7.0GB | CG | 1 month |
G10GB | GLO | ₦2,600 | 10.0GB | CG | 1 month |
A100MB | AIRTEL | ₦65 | 100MB | CG | 1 month |
A300MB | AIRTEL | ₦120 | 300MB | CG | 1 month |
A500GB | AIRTEL | ₦150 | 500MB | CG | 1 month |
A1GB | AIRTEL | ₦240 | 1GB | CG | 1 month |
A2GB | AIRTEL | ₦480 | 2GB | CG | 1 month |
A5GB | AIRTEL | ₦1,300 | 5GB | CG | 1 month |
A10GB | AIRTEL | ₦2,250 | 10GB | CG | 1 month |
E500MB | 9MOBILE | ₦450 | 500MB | CG | 1 month |
E1GB | 9MOBILE | ₦900 | 1.5GB | CG | 1 month |
E2GB | 9MOBILE | ₦1,100 | 2GB | CG | 1 month |
E3GB | 9MOBILE | ₦1400 | 3GB | CG | 1 month |
E4GB | 9MOBILE | ₦1,850 | 4GB | CG | 1 month |
Cable List
Cable ID | Cable name |
---|---|
gotv | GOTV |
dstv | DSTV |
startime | STARTIME |
Cable Plan List
Cable plan ID/Code | Cableplan name | Cableplan amount |
---|---|---|
STARTIMES | ||
smart | Smart (Dish) – ₦2,200 Monthly | ₦2,200 |
classic | Classic (Antenna) – ₦2,500 Monthly | ₦2,500 |
super | Super (Dish) – ₦4,200 Monthly | ₦4,200 |
nova | Nova – ₦300 – 1 Weekly | ₦300 |
basic-weekly | Basic (Antenna) – ₦600 Weekly | ₦600 |
smart-weekly | Smart (Dish) – ₦700 Naira Weekly | ₦700 |
classic-weekly | Classic (Antenna) – ₦1200 Weekly | ₦1,200 |
basic | Basic (Antenna) – ₦1,700 Monthly | ₦1,700 |
GOTV | ||
gotv-smallie | Smallie Monthly ₦900 | ₦1,900 |
gotv-jinja | Jinja Monthly ₦1900 | ₦1,900 |
gotv-jolli | Jolli Monthly ₦2800 | ₦2,800 |
gotv-max | Max Monthly ₦4200 | ₦4,250 |
gotv-3months-smallie | Smallie 3 months ₦2400 | ₦2,400 |
gotv-smallie-1year | Smallie Yearly ₦7000 | ₦7,000 |
DSTV | ||
dstv-padi | DStv Padi = ₦2150 | ₦2,150 |
dstv-yanga | DStv Yanga ₦2,950 | ₦2,950 |
dstv-confam | Dstv Confam ₦5,300 | ₦5,300 |
dstv79 | DStv Compact ₦9,000 | ₦9,000 |
dstv3 | DStv Premium ₦21,000 | ₦21,000 |
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