1. M o b i l e R e c h a r g e A P I b y S a u r a b h S h a r m a | 1
http://www.rechargekarlo.com|[Online Recharge Made Easy]
Recharge Made Easy @ RechargeKarlo.com – A creative venture under
htttp://www.sabkuchkarlo.com by TechShareZone Community
Mobile Recharge API
Integration Document
By
Saurabh Sharma
[M. Tech-CSE]

2. M o b i l e R e c h a r g e A P I b y S a u r a b h S h a r m a | 2
http://www.rechargekarlo.com|[Online Recharge Made Easy]
Main API URL : http://mobile.rechargekarlo.com/
SSL also
supported https://mobile.rechargekarlo.com/
Each API is IP Restricted You need to provide your server ip to integrate this API.
We do have Test Mode for Which IP is not required, and you receive Dummy output
For each test Recharge.
You need to provide your Response Url, where you will get a transaction status hit.
Ex. http://www.rechargekarlo.com/tszResponse.jspx
.jspx can be any file extension as php, jsp and aspx any of your application extension
Method: POST [method we use when sending response to your URL]
Parameter:
xmldata=
<Data>
<Status>SUCCESS</Status>
<TalkTime>0</TalkTime>
<OperatorTxnId>GU0012337209</OperatorTxnId>
<Description>Transaction Successful</Description>
<MerOid>1234600</MerOid>
<OrderId>4133</OrderId>
<Mobile>9913099732</Mobile>
<Denomination>10</Denomination>
<MerNotes/>
<CreditUsed>9.808</CreditUsed>
<Balance>9999999726.88</Balance>
</Data>

3. M o b i l e R e c h a r g e A P I b y S a u r a b h S h a r m a | 3
http://www.rechargekarlo.com|[Online Recharge Made Easy]
Input
URL: …/reseller/FlexiRechargeAPI.php
Parameters:
reseller_id=<Your ResellerID>&reseller_pass=<Your Reseller
Pass>&denomination=<Recharge Amount>&mobilenumber=<Mobile
Number>&operatorid=<Operator Id>&meroid=<Your System Generated Order/
Id>&circleid=<Circle Id>&voucher=<Voucher Type if Specified>
Request Parameters Data Type Description
reseller_id Numeric Your reseller id as provided by
us.
reseller_pass Alpha-Numeric API Password as provided by
Us.
denomination Numeric Amount for which mobile is to
be recharged
mobilenumber Numeric Mobile that is to be recharged
operatorid Numeric Operator id as provided by Us
for each mobile / dth operators
meroid Numeric or Alpha-Numeric Your System generated Orderid
circleid Numeric Or ‘*’ ‘*’ stands for all circles and
Other Numeric Specified as per
List provided by Us.
voucher Text
Default : blank
Example:
voucher=
Should be Provided as per
Operator’s Usage
mernotes Text [ Optional ] Optional Parameter
Specify any description
related to this Recharge

4. M o b i l e R e c h a r g e A P I b y S a u r a b h S h a r m a | 4
http://www.rechargekarlo.com|[Online Recharge Made Easy]
Output:
API Output Parameters in Xml Format
Response
Parameter
Data Type Desc.
Status Text Recharge Status
TalkTime Numeric Float TalkTime Provided by
operator to customer
OperatorTxnId Alpha-Numeric Operator Provided
Transaction Id
Description Text Recharge status
Description
OrderId Numeric our System generated
Orderid
MerOid Numeric OR
Alpha-numeric
Your System
Generated OrderId
Mobile Numeric Mobile Recharged
Denomination Numeric Amount Recharged
MerNotes Text [Optional] Optional Parameter
Specify any
description
related to this
Recharge
CreditUsed Numeric Float Amount Deducted for
successful recharge
done
Balance Numeric Float Your Balance After
Recharge
Example:
SUCCESS Recharge FAILED Recharge
<Data>
<Status>SUCCESS</Status>
<TalkTime>0</TalkTime>
<OperatorTxnId>GU0012337209</OperatorTxnId>
<Description>Transaction
Successful</Description>
<MerOid>1234600</MerOid>
<OrderId>4133</OrderId>
<Mobile>9913099732</Mobile>
<Denomination>10</Denomination>
<MerNotes/>
<CreditUsed>9.808</CreditUsed>
<Balance>9999999726.88</Balance>
</Data>
<Data>
<Status>FAILED</Status>
<TalkTime>0</TalkTime>
<OperatorTxnId>#</OperatorTxnId>
<Description>Do Not Use The Same
Number in 5 Minute
Interval</Description>
<MerOid>1234603</MerOid>
<Mobile>9913099732</Mobile>
<Denomination>10</Denomination>
<OrderId>4136</OrderId>
<MerNotes>Test Recharge</MerNotes>
<CreditUsed>9.808</CreditUsed>
<Refunded>9.808</Refunded>
<Balance>9999999707.26</Balance>
</Data>
<Data>
<Error>Merchant Order Id already
Exists in system</Error>
</Data>

5. M o b i l e R e c h a r g e A P I b y S a u r a b h S h a r m a | 5
http://www.rechargekarlo.com|[Online Recharge Made Easy]
Recharge Status
Method: GET
URL:
…/reseller/RechargeStatusAPI.php
Params:
reseller_id=<Your Reseller Id>&reseller_pass=<Your API Password>&orderid=<Our
System OrderID>&meroid=<Your system OrderId>
API Input Parameters as Web URL Get Method
Request Parameter Data Type Desc.
reseller_id Numeric Your Reseller id
Generated and given
by rechargekarlo
reseller_pass Alpha-Numeric Your Reseller API
password
orderid Numeric rechargekarlo
generated Orderid
meroid Alpha-Numeric OR
Numeric
Your System
Generated OrderId
Output
API Output Parameters in Xml Format
Response
Parameter
Data Type Desc.
OrderId Numeric rechargekarlo
generated Orderid
MerOid Numeric Your System
Generated OrderId
Mobile Numeric Mobile Recharged
Denomination Numeric Amount Recharged
Status Text Recharge Status
OperatorTxnId Alpha-Numeric Operator Provided
Transaction Id
Description Text Recharge status
Description
Output in Xml Format:
non-Error Output Error OUTPUT
<RechargeStatus>
<OrderId>4137</OrderId>
<MerOid>4133</MerOid>
<Mobile>9913099732</Mobile>
<Denomination>10</Denomination>
<Status>SUCCESS</Status>
<OperatorTxnId>GU00</OperatorTxnId>
<Description>Transaction
Successful</Description>
</RechargeStatus>
<RechargeStatus>
<Error>Invalid Reseller
Details</Error>
</RechargeStatus>

6. M o b i l e R e c h a r g e A P I b y S a u r a b h S h a r m a | 6
http://www.rechargekarlo.com|[Online Recharge Made Easy]
Reseller Balance API
Method: GET
URL: …/reseller/ResellerBalanceAPI.php
Parameters: reseller_id=<Your Reseller Id>&reseller_pass=<Your API Password>
Request Parameters Data Type Description
reseller_id Numeric Your Reseller id provided by us.
reseller_pass Alpha-Numeric Your API Password
Output:
Response Parameters Data Type Description
Balance Float Your available balance with us.
Error Text Available only if Error is
Generated.
Non-Error Output Error Output
<Data>
<Balance>9999999707.26</Balance>
</Data>
<Data>
<Error>Invalid Reseller Details</Error>
</Data>
Reseller Operators API (Get List of Operator Enabled for Me)
Method: GET
URL: …/reseller/ResellerOperatorsAPI.php
Parameters: reseller_id=<Your Reseller Id>&reseller_pass=<Your API Password>
Request Parameters Data Type Description
reseller_id Numeric Your Reseller id provided by us.
reseller_pass Alpha-Numeric Your API Password
Output:
Response Parameters Data Type Description
OperatorId Integer Our System Generated
Operator Id, which you need to
Provide when you trigger
Operator based Queries, or
When you Trigger Recharge API
OperatorName Text This Fields Specify Operator
Name, which is Displayed to
Educate you which Id stands
for which Operator in our
System.

7. M o b i l e R e c h a r g e A P I b y S a u r a b h S h a r m a | 7
http://www.rechargekarlo.com|[Online Recharge Made Easy]
Non-Error Output Error Output
<OperatorList>
<Operator_1>
<OperatorId>1</OperatorId>
<OperatorName>Reliance</OperatorName>
</Operator_1>
<Operator_2>
<OperatorId>2</OperatorId>
<OperatorName>Idea</OperatorName>
</Operator_2>
<Operator_3>
<OperatorId>3</OperatorId>
<OperatorName>Vodafone</OperatorName>
</Operator_3>
<Operator_4>
<OperatorId>4</OperatorId>
<OperatorName>LOOP Mobile</OperatorName>
</Operator_4>
…
</OperatorList>
<Data>
<Error>Invalid Reseller Details
</Error>
</Data>
Reseller Flexi-Vouchers List
Method: GET
URL: …/reseller/ResellerFlexiVouchersAPI.php
Parameters: reseller_id=<Your Reseller Id>&reseller_pass=<Your API Password>
Request Parameters Data Type Description
reseller_id Numeric Your Reseller id provided by us.
reseller_pass Alpha-Numeric Your API Password
Output:
See Next Page

8. M o b i l e R e c h a r g e A P I b y S a u r a b h S h a r m a | 8
http://www.rechargekarlo.com|[Online Recharge Made Easy]
Output:
Non-Error Output Error Output
<FlexiVouchersList>
<Operators>
<BSNL>
<OperatorId>5</OperatorId>
<Circles>
<PUNJAB>
<CircleId>1</CircleId>
<Vouchers>
<Recharge>
<description>Recharge</description>
<denominations>
1,2,3,5,7,13,14,17,20,30,31,33,35,39,40,
45,47,49,53,54,55,61,65,98,99,110,150,27
4,280,300,330,500,550,999,1100,3300
</denominations>
<Deno_1>
<Talktime>0</Talktime>
<Adminfee>0</Adminfee>
<Servicetax>0.01</Servicetax>
<Validity>0</Validity>
</Deno_1>
…
<Deno_3300>
<Talktime>0</Talktime>
<Adminfee>0</Adminfee>
<Servicetax>0.01</Servicetax>
<Validity>0</Validity>
</Deno_3300>
</Recharge>
</Vouchers>
</PUNJAB>
</Circles>
</BSNL>
<TATA_SKY>
<OperatorId>6</OperatorId>
<Circles>
<All_Circles>
<CircleId>0</CircleId>
<Vouchers>
<Blank>
<description>Blank</description>
<denominations>0</denominations>
<Deno_0>
<Talktime>0</Talktime>
<Adminfee>0</Adminfee>
<Servicetax>0</Servicetax>
<Validity>0</Validity>
</Deno_0>
</Blank>
</Vouchers>
</All_Circles>
</Circles>
</TATA_SKY>
</Operators>
</FlexiVouchersList>
<Data>
<Error>Invalid Reseller
Details </Error>
</Data>