A Mobile & DTH Recharge API allows businesses to integrate mobile and Direct-to-Home (DTH) recharge services into their applications or websites. These APIs facilitate the automatic processing of recharges for various service providers.
Contents
Key Features of a Recharge API
- Multiple Service Provider Support: Support for various telecom and DTH service providers.
- Real-time Processing: Instant recharge processing and status updates.
- Error Handling: Comprehensive error handling to manage failed transactions.
- Security: Secure transaction handling, often involving encryption and secure protocols.
- Reporting and Analytics: Detailed reports and analytics on transactions.
Common Use Cases
- E-commerce Platforms: Allow users to recharge their mobile phones or DTH services directly.
- Mobile Wallets: Integrate recharge functionalities into mobile wallet applications.
- Third-Party Applications: Provide value-added services in applications such as travel booking, financial services, etc.
How to Use a Recharge API
- Sign Up with a Provider: Choose a recharge API provider and sign up for their service.
- Obtain API Credentials: Get the necessary API key, secret, and other credentials.
- API Integration: Use the provider’s documentation to integrate the API into your application.
- Testing: Test the integration thoroughly in a sandbox environment provided by the API provider.
- Go Live: Once testing is complete, move to the production environment.
Example Providers
- Deeperweb for Business: Provides a comprehensive recharge API for mobile and DTH services.
- ( www.deeperweb.in )
Sample API Workflow
- Authentication: Authenticate with the API using your credentials.
- Check Balance: Verify the balance available for transactions.
- Initiate Recharge: Send a request to recharge a specific mobile number or DTH account.
- Receive Response: Get a response from the API indicating the success or failure of the recharge.
- Handle Errors: Manage any errors or exceptions that occur during the process.
Example Code Snippet
Here’s a simplified example of how a mobile recharge API request might look in Python:
import requests
# API credentials
api_key = 'your_api_key'
api_secret = 'your_api_secret'
# Recharge details
mobile_number = '9876543210'
operator = 'Airtel'
amount = 100
# API endpoint
url = 'https://api.deeperweb.in/recharge'
# Headers
headers = {
'Authorization': f'Bearer {api_key}',
'Content-Type': 'application/json'
}
# Payload
payload = {
'mobile_number': mobile_number,
'operator': operator,
'amount': amount
}
# Make the request
response = requests.post(url, headers=headers, json=payload)
# Process the response
if response.status_code == 200:
print('Recharge successful:', response.json())
else:
print('Failed to recharge:', response.json())
Security Considerations
- Use HTTPS: Ensure all API requests are made over HTTPS to secure the data in transit.
- API Key Management: Keep your API keys secure and do not expose them in client-side code.
- Rate Limiting: Implement rate limiting to avoid abuse and ensure fair usage of the API.
Documentation and Support
Always refer to the official documentation provided by the API provider for the most
accurate and detailed instructions. Here are some documentation links for popular providers:
- DeeperWeb: Deeperweb API Documentation
Getting Started with a Recharge API
- Choose a Provider: Select a provider based on your requirements such as supported regions, service providers, pricing, and support.
- Create an Account: Sign up for an account with the chosen API provider.
- API Key Generation: Generate your API keys and other necessary credentials.
- Follow Integration Guide: Use the provider’s integration guide to incorporate the API into your system.
- Test Environment: Utilize the test or sandbox environment to perform thorough testing.
- Move to Production: After successful testing, switch to the production environment and go live.
Best Practices
- Error Logging: Implement robust logging to track errors and issues during the recharge process.
- User Notifications: Notify users about the status of their recharges (success, failure, pending).
- Retry Mechanism: Implement a retry mechanism for failed transactions due to temporary issues.
- Compliance: Ensure compliance with local regulations and industry standards regarding transactions and user data.
Integrating a Mobile & DTH Recharge API can significantly enhance the functionality of your application or platform, providing users with a seamless experience for managing their recharge needs.
API Document
1. Recharge / Bill Payment API
Request : https://www.deeperweb.in/webservices/api/recharge?username=[username]&api_token=[api_token]&number=[number]&amount=[amount]&operator=[operator_code]&ref_id=[your_ref_id] &field1=[field_1_value]&field2=[field_2_value]&field3=[field_3_value]&field4=[field_4_value]&field5=[field_5_value]
Response (in JSON) :
{"status":"Accepted","number":"9999999999","amount":"10","operator":"VF","ref_id":"ABC1","txn_id":"123456","opt_id":"ABCDEFGH12345","balance" : "100.00", "message":"Recharge request accepted." }
Request Pramaters List
PARAMETER | DESCRIPTION |
---|---|
username | Your registered mobile number with us |
api_token | APIKEY generated in profile section Get API Token |
number | Recharge number / DTH Connection number / Billpayment Customer Number |
amount | Recharge Amount |
operator | Operator code Get Operator Codes |
ref_id | Unique transaction id generated from your server/website |
field1 | Refer Operator List (For Billpayment Operators only) |
field2 | Refer Operator List (For Billpayment Operators only) |
field3 | Refer Operator List (For Billpayment Operators only) |
field4 | Refer Operator List (For Billpayment Operators only) |
field5 | Refer Operator List (For Billpayment Operators only) |
Response Pramaters List
PARAMETER | DESCRIPTION |
---|---|
status | Pending : When we have successfully accepted your recharge request. Accepted : When we have successfully accepted your recharge request. Success : When your recharge processed successfully. Failure : When your recharge is failed / rejected by operator. Refunded : When we have refuned your recharge. Error : When your request has some wrong data. You can consider it as FAILURE only for RECHARGE API NOTE: DO NOT CONSIDER AS FAILURE IN STATUS CHECK API |
number | Recharge mobile number / DTH connection number |
amount | Recharge Amount |
operator | Operator code (Visit Website -> API Configuration -> Operator Code List) |
ref_id | Unique transaction id generated from your server/website |
txn_id | Unique ID generated by Deeper Web Technology |
opt_id | Unique reference id generated by Operator |
balance | Closing balance afer this recharge |
message | A simple string which shows error message. |
2. Recharge Callback URL
Request : http://[YOUR_CALLBACK_PAGE]?number=[RECHARGE_NUMBER]&amount=[AMOUNT]&txnId=[OUR_UNIQUE_ID]&refId=[YOUR_UNIQUE_ID]&status=[Success/Failure/Refunded]&operatorId=[OPERATOR'S_UNIQUE_ID]&operatorCode=[OPERATOR_CODE]&balance=[YOUR_BALANCE]
Pramaters List
PARAMETER | DESCRIPTION |
---|---|
number | Recharge number / DTH Connection number / Billpayment Customer Number |
amount | Recharge Amount |
txnId | Unique ID generated by Deeper Web Technology |
refId | Unique transaction id generated from your server/website |
status | Success : When your recharge processed successfully. Failure : When your recharge is failed / rejected by operator. Refunded : When we have refuned your recharge. |
operatorId | Unique reference id generated by Operator |
operatorCode | Operator code Get Operator Codes |
balance | Your updated balance after this transaction. |
3. Status Check API (By REF_ID : Your unique transaction number)
Request : https://www.deeperweb.in/webservices/api/statusByRefId?username=[username]&api_token=[api_token]&ref_id=[your_ref_id]&recharge_date=[YYYY-MM-DD]
Response (in JSON) :
{"status":"Success","number":"9999999999","amount":"10","operator":"VF","ref_id":"ABC1","txn_id":"123456","opt_id":"ABCDEFGH12345","balance" : "100.00","message":"Recharge is successfull." }
Request Pramaters List
PARAMETER | DESCRIPTION |
---|---|
username | Your registered mobile number with us |
api_token | APIKEY generated in profile section Get API Token |
ref_id | Unique transaction id generated from your server/website |
recharge_date | Recharge date in (YYYY-MM-DD) format. Example : 2020-03-15 |
Response Pramaters List
PARAMETER | DESCRIPTION |
---|---|
status | Pending : When your recharge is in processing. Success : When your recharge processed successfully. Failure : When your recharge is failed / rejected by operator. Refunded : When we have refuned your recharge. Error : When your request has some wrong data. NOTE: DO NOT CONSIDER AS FAILURE. IT IS JUST STATUS OF YOUR INVALID STATUS CHECK REQUEST |
number | Recharge number / DTH Connection number |
amount | Recharge Amount |
operator | Operator code (Visit Website -> API Configuration -> Operator Code List) |
ref_id | Unique transaction id generated from your server/website |
txn_id | Unique ID generated by Deeper Web Technology |
opt_id | Unique reference id generated by Operator |
balance | Closing balance afer this recharge |
message | A simple string which shows error message. |
4. Balance API
Request : https://www.deeperweb.in/webservices/api/balance?username=[username]&api_token=[api_token]
Response (in JSON) :
{"status":"Ok","totalBalance":"0.00", "rechargeBalance":"0.00","utilityBalance":"0.00","aepsBalance":"0.00","message" : "Balance fetched successfully."}
Request Pramaters List
PARAMETER | DESCRIPTION |
---|---|
username | Your registered mobile number with us |
api_token | APIKEY generated in profile section Get API Token |
Response Pramaters List
PARAMETER | DESCRIPTION |
---|---|
status | Success : Your request processed and found valid details. Error : When your request has some wrong data. |
totalBalance | Total balance of your account (Main + Utility + AePS Balance) |
mainBalance | Available balance for recharge / dmt service usage. |
aepsBalance | Available balance for AePS service purpose. |
message | Balance fetched successfully. |
5. Complain/Dispute API
Request : https://www.deeperweb.in/webservices/api/complain?username=[username]&api_token=[api_token]&txn_id=[Deeper Web Technology's Tranaction Id]&reason=[MESSAGE]
Response (in JSON) :
{"status":"Accepted","message":"Your complain accepted and will be solved soon.","complain_id":"1"}
Request Pramaters List
PARAMETER | DESCRIPTION |
---|---|
username | Your registered mobile number with us |
api_token | APIKEY generated in profile section Get API Token |
txn_id | Unique ID generated by Deeper Web Technology |
reason | Your Message/Remark for that transaction |
Response Pramaters List
PARAMETER | DESCRIPTION |
---|---|
status | Accepted : Your complain request accepted. Error : When your request has some wrong data. |
message | CUSTOM MESSAGE FROM SERVER |
complain_id | UNIQUE COMPLAIN ID generated by Deeper Web Technology |
Operator Codes
Mobile Operators | ||
Operator | Code | |
Airtel | AT | |
BSNL | BT | |
BSNL SPECIAL | BSP | |
Jio | JIO | |
Vi | VI |
DTH Operators | ||
Operator | Code | |
Airtel DTH | ATDTH | |
Dish TV | DISHTV | |
Sun Direct | SUNDTH | |
Tata Sky | TATASKY | |
Videocon D2H | VDDTH |
Electricity Operators | ||
Operator | Code | Fields |
Adani Electricity Mumbai Limited | EADANI | field1 : Consumer Number |
Ajmer Vidyut Vitran Nigam Ltd | EAVVNL | field1 : K Number |
APEPDCL – Eastern Power Distribution CO AP Ltd. | APEPDCL | field1 : Service Number |
APSPDCL – Southern Power Distribution CO AP Ltd. | APSPDCL | field1 : Service Number |
Assam Power Distribution Company Ltd | EAPDCL | field1 : Consumer ID |
Assam Power Distribution Company Ltd (NON-RAPDR) | EADPCLN | field1 : Consumer ID |
Bangalore Electricity Supply | BES | field1 : Customer ID / Account ID |
BEST | BEST | field1 : Consumer Number |
Bhagalpur Electricity Distribution Company (P) Ltd | BEDCL | field1 : Account Number |
Bharatpur Electricity Services Ltd. (BESL) | BESL | field1 : K Number |
Bikaner Electricity Supply Limited (BkESL) | BKESL | field1 : K Number |
Brihan Mumbai Electric Supply And Transport Undertaking | BMESTU | field1 : Consumer Number |
Brihanmumbai Electric Supply And Transport | BESAT | field1 : Consumer Number |
BSES Rajdhani Power Limited | BSESR | field1 : CA Number |
BSES Yamuna Power Limited | BSESY | field1 : CA Number |
Calcutta Electricity Supply Ltd (CESC LTD) | CESC | field1 : Consumer No |
CESU, Odisha | CESU | field1 : Consumer Id |
Chamundeshwari Electricity Supply Corp Ltd (CESCOM) | CESCOM | field1 : Account ID(RAPDRP) OR Consumer No./Connection ID(Non-RAPDRP) |
Chandigarh Electricity Department | CED | field1 : Account No without(/) |
Chhattisgarh Electricity Board | CEB | field1 : Business Partner Number |
Dakshin Gujarat Vij Company Ltd | DGVCL | field1 : Consumer Number |
Dakshin Haryana Bijli Vitran Nigam (DHBVN) | DHBVN | field1 : Account Number field2 : Mobile Number (+91) field3 : Mobile Number (+91) |
Daman and Diu Electricity Department | DDED | field1 : Account number |
Department of Power, Nagaland | DPN | field1 : Consumer ID |
Dnh Power Distribution Company Limited | DPDCL | field1 : Service Connection Number |
Goa Electricity Department | GOAED | field1 : Contract Account No |
Government of Puducherry Electricity Department | GPED | field1 : Consumer Number field2 : Consumer Type field3 : Consumer Type |
Gulbarga Electricity Supply Company Limited | GESL | field1 : Consumer Number |
Himachal Pradesh Electricity | HPE | field1 : Consumer ID |
Hubli Electricity Supply Company Ltd (HESCOM) | HESCOM | field1 : Account ID(RAPDRP) OR Consumer No./Connection ID(Non-RAPDRP) |
India Power Corporation – West Bengal | IPCWB | field1 : Consumer Number |
India Power Corporation Limited | IPCL | field1 : Consumer Number |
Jaipur Vidyut Vitran Nigam Ltd | JVVNL | field1 : K NO |
Jammu and Kashmir Power Development Department | JKPDD | field1 : Consumer Code |
Jamshedpur Utilities and Services Company | JUSE | field1 : Business Partner Number |
Jharkhand Bijli Vitran Nigam Limited (JBVNL) | JBVNL | field1 : Consumer Number field2 : Subdivision Code |
Jodhpur Vidyut Vitran Nigam Ltd | JOVVNL | field1 : K Number |
Kanpur Electricity Supply Company Ltd (KESCO) | KESCO | field1 : Account Number |
Kerala State Electricity Board Ltd. (KSEBL) | KSEBL | field1 : Consumer Number |
Kota Electricity Distribution Limited (KEDL) | KEDL | field1 : K Number |
M.p. Madhya Kshetra Vidyut Vitaran – Agriculture | MPAGRO | field1 : Consumer Number/IVRS ID |
M.P. Madhya Kshetra Vidyut Vitaran – RURAL | MPRURAL | field1 : IVRS |
M.P. Madhya Kshetra Vidyut Vitaran – URBAN | MPURBAN | field1 : IVRS |
M.P. Paschim Kshetra Vidyut Vitaran | MPPKVV | field1 : Consumer Number |
M.P. Poorv Kshetra Vidyut Vitaran – URBAN | MPPKVU | field1 : Consumer Number/IVRS |
M.P. Poorv Kshetra Vidyut Vitaran – RURAL | MPPKVR | field1 : Consumer Number/IVRS |
Madhya Gujarat Vij Company Ltd | MGVCL | field1 : Consumer Number |
Mahavitaran-Maharashtra State Electricity Distribution Company Ltd. (MSEDCL) | MSEDCL | field1 : Consumer Number field2 : Billing Unit |
Mangalore Electricity Supply Co. Ltd (MESCOM) | MSECOM | field1 : Account ID |
Meghalaya Power Distribution Cor. Ltd | MPDCL | field1 : Consumer ID |
MP-Poorv Kshetra Vidyut Vitaran Co. Ltd.(Jabalpur) | MPJBL | field1 : Consumer Number/IVRS |
Muzaffarpur Vidyut Vitran Limited | MVVL | field1 : Consumer Number |
NESCO, Odisha | NESCO | field1 : Consumer Number |
New Delhi Municipal Council (NDMC) – Electricity | NDMC | field1 : Consumer Number |
Noida Power Company Limited | NPCL | field1 : Consumer Number |
North Bihar Power Distribution Company Ltd. | NBPDCL | field1 : CA Number |
Northern Power Distribution Of Telanagana Ltd | NPDTL | field1 : USC No |
Odisha Discoms B2B | ODIB2B | field1 : Consumer Number |
Odisha Discoms B2C | ODIB2C | field1 : Consumer Number |
Paschim Gujarat Vij Company Ltd | PGVCL | field1 : Consumer Number |
Power & Electricity Department Government Of Mizoram | PEDGM | field1 : Consumer Number |
Punjab State Power Corporation Ltd (PSPCL) | PSPCL | field1 : Account Number |
Rajasthan Vidyut Vitran Nigam Limited | RVVNL | field1 : K Number |
Sikkim Power – URBAN | SKMU | field1 : Contract Acc Number |
Sikkim Power – RURAL | SKMR | field1 : Contract Acc Number |
South Bihar Power Distribution Company Ltd. | SBPDCL | field1 : CA Number |
SOUTHCO, Odisha | SOUTHCO | field1 : Consumer Number |
Tamil Nadu Electricity Board (TNEB) | TNEB | field1 : Consumer Number |
Tata Power Delhi Distribution Ltd | TPDDL | field1 : Customer Account Number |
Tata Power Mumbai | TATAPM | field1 : Consumer Number |
Torrent power – Agra | TORAGRA | field1 : Service Number |
Torrent power – Ahmedabad | TORAHM | field1 : Service Number |
Torrent power – Bhiwandi | TORBHI | field1 : Service Number |
Torrent power – Surat | TORSURAT | field1 : Service Number |
TP Ajmer Distribution Ltd (TPADL) | TPADL | field1 : K Number |
Tp Center Odisha Distribution Limited | TPCODL | field1 : Consumer Number |
Tripura State Electricity Board | TSEB | field1 : Consumer ID |
Uttar Gujarat Vij Company Ltd | UGVCL | field1 : Consumer Number |
Uttar Haryana Bijli Vitran Nigam (UHBVN) | UHBVN | field1 : Account Number field2 : Mobile Number (+91) field3 : Mobile Number (+91) |
Uttar Pradesh Power Corp Ltd (UPPCL) – RURAL | UPPCLR | field1 : Consumer Number |
Uttar Pradesh Power Corp. Ltd. (UPPCL) – URBAN | UPPCLU | field1 : Consumer Number |
Uttarakhand Power Corporation Limited | UPCL | field1 : Service Connection Number |
WESCO Utility | WESCOU | field1 : Consumer Number |
West Bengal State Electricity | WBSEDCL | field1 : Consumer Id field2 : Registered mobile number |
Postpaid Operators | ||
Operator | Code | |
Airtel Postpaid | PA | |
BSNL Postpaid | PB | |
JIO Postpaid | PJIO | |
VI Postpaid | PV |
GiftCard Operators | ||
Operator | Code | Fields |
Google Play Code | GPLAY | field1 : Mobile No |
Payment Gateway:
- TOP 10 BEST PAYMENT GATEWAY IN INDIA (2020)
- PhonePe Payment Gateway
- PayKun – Best Payment Gateway For India 2021
- UPIGateway
- Freecharge PG
- PayU – Payment Gateway
Credit Card:
- Kotak upi rupay credit card apply online
- HDFC Bank UPI RuPay Credit Card
- IDFC FIRST Power Rupay Credit Card
- PCI DSS
Banking:
- Register to IndusNet Online Banking
- BOB Kiosk Banking, BOB CSP, BC Commission chart 2024-25
- Documents Required for Opening a Current Account Online
- csc digipay lite commission 2023-2024
- DigiPay v7.3
- Airtel Payment Bank CSP
- SBI CSP Commission Structure
- SBI CSP – How to register sbi csp
- Fino CSP Lite Login
- Fino Payment Bank CSP Login
- how to apply fino payment bank csp
- Fino Payment Bank Commission 2023-2024
- Instant PIN Generation for Debit Card
- BOB CSP Browser Settings
- 7 Points on UPI Payments
- 5 Best Refer and Earn UPI Apps: Earn Free Cash Online
Other’s:
- Beyond the Beast: Jay Leno Tames the F-150 Raptor R and Unveils Its True Power
- Clash of Titans: Warriors vs. Nuggets – The Ultimate NBA Showdown Unveiled!
- United States one-dollar bill
- South Texas College – Pecan Campus
- How to disable right-clicking on a website using JavaScript?
- Unlocking Craig Brown’s Secrets to Success: The Ultimate Guide
- Unsolved Mystery: The Fate of the Five Men Aboard the Missing Titanic Tourist Submersible
- The NCAA Women’s Basketball Champion
- Dodgers
- Indian Premier League 2024
- Real-Time Billionaires
- Bernard Arnault & family
- Los Angeles Lakers
Following my social platform
Web | www.mytechtrips.com |
Join telegram channel | Click here |
Join WhatsApp group | Click here |
Click here | |
Click here | |
Youtube Channel 1 | Click here |
Youtube Channel 2 | Click here |