Top Banner
Recharge & Bill API Guide Version 3.0
31

Jolo Recharge API Docs

Jan 19, 2016

Download

Documents

Gopal Joshi

Jolo_Recharge_API_Docs.pdf
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: Jolo Recharge API Docs

Recharge & Bill API Guide Version 3.0

Page 2: Jolo Recharge API Docs

Index Topic Page No.

Introduction 3

How to buy API 4

Mobile, DTH, Data-card & Post-paid API link 5

Landline & Broadband API link 8

Check transaction status (all services) 11

Synchronization 13

Report transaction (Dispute) 14

Check API balance 16

Backup route API link 17

Antivirus subscription API 19

Get operator service status 23

Appendix A, B, C 24

API plans and pricing 30

Page 3: Jolo Recharge API Docs

Introduction In this PDF, you will get all information related to our mobile, dth, datacard, postpaid, landline, antivirus api in detail. This guide will help you to integrate our api in your website easily and in quick time. If you want to test before going live always set mode equal to 0 in our api http url. If you have no time to integrate our api in your website then don’t worry we provide free support for installation free of cost. Just drop a request to our support desk anytime. We are always 24x7. For any help, please write to our support desk: [email protected] We will assure you to deliver response to your query within 24 hours or max 36 hours.

Page 4: Jolo Recharge API Docs

How to buy API

• Create free account on www.jolo.in/member/signup.php • Pay API annual activation fee as per plan selected by you. After payment send your payment details along with your jolo username to [email protected] and then allow us 1 hour to activate the same.

• You can pay via online bank fund transfer/neft/gcc/atm/cheque/ dd • For any purchase related queries contact our sales team: [email protected] • For any technical/support related queries contact our support desk: [email protected]

Page 5: Jolo Recharge API Docs

API LINK (common for Mobile, DTH, Data-card & Post-paid service)

http://jolo.in/api/recharge_advance.php?mode=1&key=appkey& operator=operatorcode&service=servicenumber&amount=amount&orderid=yourwebsiteorderid

URL Parameters Description

Mode Set mode = 1 for live & mode = 0 for test

Key Your application key generated from Jolo account

Operator Operator code (see appendix A)

Service 10 digit mobile number or DTH subscriber id

Amount Denomination ranging from 10 to 10,000

Order ID Your website generated Unique order ID

Application key generation link: http://www.jolo.in/member/panel/myappkey.php

Page 6: Jolo Recharge API Docs

API LINK RESPONSE (common for Mobile, DTH, Data-card & Post-paid service)

Jolo order id, status, operator, service, amount, your website orderid, errorcode, operatorid

URL Response Data Description

Jolo Order ID Jolo system generated unique order ID

Status Staus of transaction (SUCCESS/FAILED/PENDING)

Operator Operator code (see appendix A)

Service 10 digit mobile number or DTH subscriber id

Amount Denomination ranging from 10 to 10,000 (Min. 100 for post-paid bills)

Order ID Your website generated Unique order ID

Error code Jolo system generated error code (see appendix B)

Operator ID Operator system generated reference ID

Page 7: Jolo Recharge API Docs

API LINK EXAMPLE (common for Mobile, DTH, Data-card & Post-paid service)

http://jolo.in/api/recharge_advance.php?mode=1&key=cking79& operator=VF&service=9999999999&amount=50&orderid=1234567890

URL Parameters Description

Mode mode = 1 for live recharge

Key Suppose cking79 is application key of your jolo account

Operator VF operator code for vodafone used (see appendix A)

Service 9999999999 is mobile number to be recharge

Amount 50 is denomination of recharge

Order ID 1234567890 is your website generated order id

Types of status Description

SUCCESS Transaction is success and your jolo balance debited

FAILED Transaction is failed and your jolo balance not debited

PENDING Transaction is pending and your jolo balance debited

Page 8: Jolo Recharge API Docs

API LINK 2 (only for Landline & broadband service)

http://jolo.in/api/landline.php?mode=1&key=appkey&operator=operatorcode&service=landlinenumber&other=accountnumber&amount=amount&std=stdcode&orderid=yourwebsiteorderid

URL Parameters Description

Mode Set mode = 1 for live & mode = 0 for test

Key Your application key generated from Jolo account

Operator Operator code (see appendix A)

Service Landline number without std code

Amount Denomination ranging from 100 to 10,000

Order ID Your website generated Unique order ID

Other Customer account number as given on bill

Std Std code of landline number

Note: In case of Tikona, put customer userid in “service” parameter & 0 in “std”.

Page 9: Jolo Recharge API Docs

API LINK 2 RESPONSE

Jolo order id, status, operator, service, amount, your website orderid, error code

URL Response Data Description

Jolo Order ID Jolo system generated unique order ID

Status Staus of transaction (SUCCESS/FAILED/PENDING)

Operator Operator code (see appendix A)

Service Landline number without std code

Amount Denomination ranging from 10 to 10,000

Order ID Your website generated Unique order ID

Error code Jolo system generated error code (see appendix B)

(only for Landline & broadband service)

Page 10: Jolo Recharge API Docs

API LINK 2 EXAMPLE

http://jolo.in/api/landline.php?mode=1&key=cking79&operator=ATL&service=4123873&other=5555555&amount=100&std=0120&orderid=1234567890

URL Parameters Description

Mode mode = 1 for live recharge

Key Suppose cking79 is application key of your jolo account

Operator ATL operator code for Airtel landline used (see appendix A)

Service 4123873 is landline number without std code

Amount 100 is denomination of bill (do not use decimal figures)

Order ID 1234567890 is your website generated order id

Other 5555555 is customer account number

Std 0120 is std code of landline number

(only for Landline & broadband service)

Page 11: Jolo Recharge API Docs

API LINK 3 (checking status of transaction, common for all services)

http://jolo.in/api/rechargestatus.php?userid=king&txn=joloorderid

URL Parameters Description

User ID Your jolo username, not appkey

TXN Jolo order ID

If you want to check recharge transaction status using your website order id then use below given link:

http://jolo.in/api/rechargestatus_client.php?userid=king&txn=yourwebsiteorderid

URL Parameters Description

User ID Your jolo username, not appkey

TXN Your website order ID

Page 12: Jolo Recharge API Docs

API LINK 3 RESPONSE

Jolo order id, status, operator, service, amount, operatorid

URL Response Data Description

Jolo Order ID Jolo system generated unique order ID

Status Current staus of transaction (SUCCESS/FAILED/PENDING)

Operator Operator code (see appendix A)

Service 10 digit mobile number or DTH subscriber id

Amount Denomination ranging from 10 to 10,000

Operator ID Operator system generated reference ID

(checking status of transaction, common for all services)

You can run this HTTP URL using CRON on your web server in order to check updated status of any recharge done. We suggest you to run cron in every 15 minutes, not before it. If you do not want to use cron then skip this page and view next page for alternate solution (auto-update status/synchronization) .

Page 13: Jolo Recharge API Docs

Synchronization: Auto-update recharge status

You can synchronize your website database transactions with our server easily for all transaction status change in real time. Whenever there will be any change in status of recharge at our end then same will be push to your website database or server. For this you just have to give us a url on which you like to get real time data. It can be like: http://yourwebsite.com/anypage.php Step 1: create file anypage.php on your server and do some coding to collect following parameters and store in database: 1. status = status of transaction 2. operatortxnid = original operator id 3. joloorderid = jolo order id 4. userorderid = your website order id Step 2: After creating page, you have to enter the url of that page in JOLO API PANEL: http://www.jolo.in/member/panel/api-auto-update.php Important: Please do not save the url until your page is ready to use. That’s it!

Page 14: Jolo Recharge API Docs

API LINK 4 (reporting any transaction, common for all services)

http://jolo.in/api/dispute.php?key=cking79&txn=joloorderid

URL Parameters Description

Key Your application key generated from Jolo account

TXN Jolo order ID

If you want to report transaction using your website order id then use below given link:

http://jolo.in/api/dispute_client.php?key=cking79&txn=yourwebsiteorderid

URL Parameters Description

Key Your application key generated from Jolo account

TXN Your website order ID

Page 15: Jolo Recharge API Docs

API LINK 4 RESPONSE

Dispute status, operatorid

URL Response Data Description

Dispute status Status of dispute

Operator ID Operator reference ID

(reporting any transaction, common for all services)

Types of DISPUTE status Description

DIS-SUCCESS,0 Your dispute request accepted by our server and transaction reported to operator successfully

FAILED,0 Your dispute request is declined because txn status is already failed and your balance is not deducted

PENDING,0 Your dispute request is declined because current txn status is pending and this transaction will auto-update itself. No need

to report such transaction

UnderDispute,0 Your dispute request is declined because txn status is already Under dispute. You need to wait for result

Other responses: INVALID-TRANSACTION-ID, INVALID-IP-ADDRESS-ACCESS, INVALID-APPKEY

Page 16: Jolo Recharge API Docs

API LINK 5 (checking your jolo balance)

http://jolo.in/api/rechargebalance.php?key=appkey

URL Parameters Description

Key Your application key generated from Jolo account

URL Response Data Description

Numeric value Your current jolo balance

Page 17: Jolo Recharge API Docs

API LINK 6 (backup route link common for Mobile, DTH service)

http://jolo.in/api/backuprecharge.php?mode=1&key=appkey&operator=operatorcode&service=service&amount=amount&circle=circlecode&orderid=yourwebsiteorderid

URL Parameters Description

Mode Set mode = 1 for live & mode = 0 for test

Key Your application key generated from Jolo account

Operator Operator code (see appendix C)

Service 10 digit mobile number or DTH subscriber id

Amount Denomination ranging from 10 to 10,000

Order ID Your website generated Unique order ID

Circle Circle code (see appendix C)

Page 18: Jolo Recharge API Docs

API LINK 6 RESPONSE

Jolo order id, status, operator, service, amount, your website orderid

URL Response Data Description

Jolo Order ID Jolo system generated unique order ID

Status Staus of transaction (SUCCESS/FAILED/PENDING)

Operator Operator code (see appendix C)

Service 10 digit mobile number or DTH subscriber id

Amount Denomination ranging from 10 to 10,000

Order ID Your website generated Unique order ID

(backup route link common for Mobile, DTH service)

New in this backup route link: - Additional parameter of "circle" is required otherwise it will give error 888. - There is change in operator code for bsnl and mtnl You will get diff. margin under backup route and its same for all api plans: http://www.jolo.in/recharge-commission.php (last column)

Page 19: Jolo Recharge API Docs

API LINK 7 (only for Antivirus service)

http://jolo.in/api/antivirus.php?mode=1&key=appkey&operator=operatorcode&mobile=mobilenumber&email=emailaddress&fname=customername&orderid=yourwebsiteorderid

URL Parameters Description

Mode Set mode = 1 for live & mode = 0 for test

Key Your application key generated from Jolo account

Operator Operator code (see appendix A)

Mobile 10 digit customer mobile number

Email Email address of customer

Fname Customer full name

Order ID Your website generated Unique order ID

Page 20: Jolo Recharge API Docs

API LINK 7 RESPONSE

Jolo order id, status, operator, mobile, email, customername, your website orderid, errorcode

URL Response Data Description

Jolo Order ID Jolo system generated unique order ID

Status Staus of transaction (SUCCESS/FAILED/PENDING)

Operator Operator code (see appendix A)

Mobile 10 digit customer mobile number

Email Email address of customer

Order ID Your website generated Unique order ID

Error code Jolo system generated error code (see appendix B)

Customer name Full name of customer

(only for Antivirus service)

Continued on next page...

Page 21: Jolo Recharge API Docs

API LINK 7 EXPLAINED (only for Antivirus service)

More Details on Antivirus Subscription API: In this API link, you need to push accurate customer information like customer full name, email address and mobile number because antivirus company will send activation product key to customer mobile number by sms, a confirmation email to customer email address. Example of sms that customer receive is given below: "Your Norton Internet Security product activation key is JJDVDWFMQGQYYXMQ2XXXXXXXX. Visit www.norton.com/digital for Product download & Installation instructions.“ Important Points:

Customer name Value of fname parameter must be url-encoded before you send to us otherwise it will create problems

Operator code Operator code must be correct as value of amount depends on it.

Continued on next page...

Page 22: Jolo Recharge API Docs

API LINK 7: PRODUCT LIST

Product name M.R.P (in Rs.)

Norton Mobile Security - 1 Year 599

Norton PC Internet Security - 1 Year 1399

Quick Heal Mobile Security for Android - 1 Year 599

Quick Heal Mobile Security for BlackBerry - 1 Year 599

Quick Heal Total Security for Android - 1 Year 749

Quick Heal Tablet Security for Android - 1 Year 849

Quick Heal Mobile Security for Android - 2 Year 899

Quick Heal Mobile Security for BlackBerry - 2 Year 899

Quick Heal Total Security for Android - 2 Year 1149

Quick Heal Tablet Security for Android - 2 Year 1249

(only for Antivirus service)

Please refer ‘Appendix A’ for operator codes of above listed products.

Page 23: Jolo Recharge API Docs

API LINK 8 (getting operator service status)

http://yourwebsite.com/anynewpage.php?opt=<opteratorcode>&ss=<status>

URL Parameters Description

opt Operator code (see appendix A)

ss Status (DOWN/UP)

Sometime operator service goes down for a while and to get notifications on your server, you have provide us url where you like to receive such notification like:

Whenever operator service goes down, our system will push notification to your given url with specific format having parameter as described below:

You can set notification url in Jolo API panel on this page: http://www.jolo.in/member/panel/api-servicestatus.php

Page 24: Jolo Recharge API Docs

APPENDIX A : OPERATOR LIST

Code PREPAID Operator

AT AIRTEL

VF VODAFONE

ID IDEA

TD TATA DOCOMO GSM

TDS TATA DOCOMO GSM SPECIAL

TI TATA INDICOM (CDMA)

RG RELIANCE GSM

RL RELIANCE CDMA

UN UNINOR

UNS UNINOR SPECIAL

AL AIRCEL

MS MTS

LM LOOP MOBILE

VD VIDEOCON

VDS VIDEOCON SPECIAL

Code PREPAID Operator

BS BSNL

BSS BSNL SPECIAL

MTD MTNL DELHI

MTDS MTNL DELHI SPECIAL

MTM MTNL MUMBAI

MTMS MTNL MUMBAI SPECIAL

TW TATA WALKY PREPAID

VRG VIRGIN GSM

VRC VIRGIN CDMA

T24 T24

T24S T24 SPECIAL

Page 25: Jolo Recharge API Docs

APPENDIX A : OPERATOR LIST

Code DTH Operator

SD SUN DTH

VT VIDEOCON DTH

BT RELIANCE BIG TV DTH

TS TATA SKY DTH

AD AIRTEL DTH

DT DISH DTH

Code DATACARD Operator

MS1 MTS MBROWSE

MS2 MTS MBLAZE

RL1 RELIANCE NetConnect 1X

RL2 RELIANCE NetConnect+

RL3 RELIANCE NetConnect 3G

TI1 TATA PHOTON WHIZ

TI2 TATA PHOTON+

MTDD MTNL DELHI DATACARD

MTMD MTNL MUMBAI DATACARD

BSD BSNL DATACARD

VFD VODAFONE DATACARD

ALD AIRCEL DATACARD

Code LANDLINE Operator

ATL AIRTEL Landline & Broadband

BSL BSNL Landline & Broadband

MTDL MTNL Delhi Landline & BB

TIL TATA DOCOMO CDMA Landline & BB

RCOM RELIANCE INFOCOMM

TIK TIKONA ISP

Page 26: Jolo Recharge API Docs

APPENDIX A : OPERATOR LIST

Code POSTPAID Operator

APOS AIRTEL

IPOS IDEA

VPOS VODAFONE

BPOS BSNL

LPOS LOOP

RGPOS RELIANCE GSM

RCPOS RELIANCE CDMA

DGPOS TATA DOCOMO GSM

DCPOS TATA DOCOMO CDMA

Code ANTIVIRUS Operator

NR1 Norton Mobile Security 1Y

NR2 Norton PC Internet Security 1Y

QH1 Quick Heal Mobile Security for Android 1Y

QH2 Quick Heal Mobile Security for BlackBerry 1Y

QH3 Quick Heal Total Security for Android 1Y

QH4 Quick Heal Tablet Security for Android 1Y

QH5 Quick Heal Mobile Security for Android 2Y

QH6 Quick Heal Mobile Security for BlackBerry 2Y

QH7 Quick Heal Total Security for Android 2Y

QH8 Quick Heal Tablet Security for Android 2Y

Page 27: Jolo Recharge API Docs

APPENDIX B : ERROR CODE LIST

Code Error Description

17 Insufficient balance

18,722 Invalid amount

19 Invalid operator code

20,22 Amount must be min. 10

21,30 Amount must be min. 100

23,131 Invalid mobile number

24,211 Invalid DTH number

116,117 Temp. Issue at operator side

122 Invalid circle code

128 Temp. Internal issue at jolo

130 Do not re-attempt same recharge within 15 minutes

207,208 Amount must be in range

221-223 Pending

226 Denomination temp. blocked by operator

Code Error Description

227 Number temp. blocked by operator

228 Denomination does not exist

229 Invalid number

231-234 Temp. Error from operator side

235,730 Temp. operator downtime

360 Unknown error

711 Amount must be in range

714 Invalid account number

716 Invalid number

721 Duplicate transaction error

726-729 Temp. Error from operator side

855 Min. Amount for dishtv is 250

955 Server IP address not match

Page 28: Jolo Recharge API Docs

APPENDIX C : CIRCLE CODE LIST

Code Circle

1 Punjab

2 West Bengal

3 Mumbai

4 Maharashtra

5 Delhi & NCR

6 Kolkata

7 Chennai

8 Tamil Nadu

9 Karnataka

10 UP east

11 UP west

12 Gujarat

13 Andhra Pradesh

14 Kerala

16 Madhya Pradesh

(only for backup route)

Code Circle

17 Bihar

18 Rajasthan

20 Haryana

21 Himachal Pradesh

22 Jharkhand

23 Orissa

24 Assam

25 Jammu & Kashmir

26 North east

27 Chhattisgarh

Page 29: Jolo Recharge API Docs

APPENDIX C : OPERATOR CODE LIST (only for backup route)

Code PREPAID Operator

BS1 BSNL TOPUP

BS2 BSNL STV

BS3 BSNL RECHARGE

BS4 BSNL 3G RECHARGE

MT1 MTNL TOPUP

MT2 MTNL STV

MT3 MTNL RECHARGE

Page 30: Jolo Recharge API Docs

APPENDIX D : API PLANS & PRICING

Plan name Pricing* (in Rs.) Services

Starter Plan 1,500 ALL SERVICES VIA API

Super Value Plan 8,500 ALL SERVICES VIA API & DISTRIBUTOR PORTAL

Deluxe Plan 14,500 ALL SERVICES VIA API & DISTRIBUTOR PORTAL

Super Deluxe Plan 20,500 ALL SERVICES VIA API & DISTRIBUTOR PORTAL

Super Max Plan 30,500 ALL SERVICES VIA API & DISTRIBUTOR PORTAL

* Pricing mentioned are annual basis and are non-refundable charges

• Backup route available on all api plans for free of charge. • Mixed route available on all api plans except starter plan as given above. This route provide margin of 3.4% on vodafone, idea and tata. • SMS based recharge facility • Android APP, JAVA APP

MORE BENEFITS:

VIEW MARGIN DETAIL: http://www.jolo.in/recharge-commission.php

Page 31: Jolo Recharge API Docs

THANK YOU !!

Powered by ELEANOR TRAVEL SOLUTIONS & SR GROUP LLC. J.V Website: www.jolo.in Email: [email protected] or [email protected] Customer Care: 0120-4123873 / 9650460949 DELHI ZONE: JOLO.IN 136/11, Ground Floor, Gold Plaza, Motia Khan, New Delhi - 110055.