Mobile & DTH Recharge API

Mobile & DTH Recharge API

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.

Key Features of a Recharge API

  1. Multiple Service Provider Support: Support for various telecom and DTH service providers.
  2. Real-time Processing: Instant recharge processing and status updates.
  3. Error Handling: Comprehensive error handling to manage failed transactions.
  4. Security: Secure transaction handling, often involving encryption and secure protocols.
  5. 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

  1. Sign Up with a Provider: Choose a recharge API provider and sign up for their service.
  2. Obtain API Credentials: Get the necessary API key, secret, and other credentials.
  3. API Integration: Use the provider’s documentation to integrate the API into your application.
  4. Testing: Test the integration thoroughly in a sandbox environment provided by the API provider.
  5. Go Live: Once testing is complete, move to the production environment.

Example Providers

  1. Deeperweb for Business: Provides a comprehensive recharge API for mobile and DTH services.
  2. ( www.deeperweb.in )

Sample API Workflow

  1. Authentication: Authenticate with the API using your credentials.
  2. Check Balance: Verify the balance available for transactions.
  3. Initiate Recharge: Send a request to recharge a specific mobile number or DTH account.
  4. Receive Response: Get a response from the API indicating the success or failure of the recharge.
  5. 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:

  1. DeeperWeb: Deeperweb API Documentation

Getting Started with a Recharge API

  1. Choose a Provider: Select a provider based on your requirements such as supported regions, service providers, pricing, and support.
  2. Create an Account: Sign up for an account with the chosen API provider.
  3. API Key Generation: Generate your API keys and other necessary credentials.
  4. Follow Integration Guide: Use the provider’s integration guide to incorporate the API into your system.
  5. Test Environment: Utilize the test or sandbox environment to perform thorough testing.
  6. 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

PARAMETERDESCRIPTION
usernameYour registered mobile number with us
api_tokenAPIKEY generated in profile section Get API Token
numberRecharge number / DTH Connection number / Billpayment Customer Number
amountRecharge Amount
operatorOperator code Get Operator Codes
ref_idUnique transaction id generated from your server/website
field1Refer Operator List (For Billpayment Operators only)
field2Refer Operator List (For Billpayment Operators only)
field3Refer Operator List (For Billpayment Operators only)
field4Refer Operator List (For Billpayment Operators only)
field5Refer Operator List (For Billpayment Operators only)

Response Pramaters List

PARAMETERDESCRIPTION
statusPending : 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
numberRecharge mobile number / DTH connection number
amountRecharge Amount
operatorOperator code (Visit Website -> API Configuration -> Operator Code List)
ref_idUnique transaction id generated from your server/website
txn_idUnique ID generated by Deeper Web Technology
opt_idUnique reference id generated by Operator
balanceClosing balance afer this recharge
messageA 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

PARAMETERDESCRIPTION
numberRecharge number / DTH Connection number / Billpayment Customer Number
amountRecharge Amount
txnIdUnique ID generated by Deeper Web Technology
refIdUnique transaction id generated from your server/website
statusSuccess : When your recharge processed successfully.
Failure : When your recharge is failed / rejected by operator.
Refunded : When we have refuned your recharge.
operatorIdUnique reference id generated by Operator
operatorCodeOperator code Get Operator Codes
balanceYour 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

PARAMETERDESCRIPTION
usernameYour registered mobile number with us
api_tokenAPIKEY generated in profile section Get API Token
ref_idUnique transaction id generated from your server/website
recharge_dateRecharge date in (YYYY-MM-DD) format. Example : 2020-03-15

Response Pramaters List

PARAMETERDESCRIPTION
statusPending : 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
numberRecharge number / DTH Connection number
amountRecharge Amount
operatorOperator code (Visit Website -> API Configuration -> Operator Code List)
ref_idUnique transaction id generated from your server/website
txn_idUnique ID generated by Deeper Web Technology
opt_idUnique reference id generated by Operator
balanceClosing balance afer this recharge
messageA 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

PARAMETERDESCRIPTION
usernameYour registered mobile number with us
api_tokenAPIKEY generated in profile section Get API Token

Response Pramaters List

PARAMETERDESCRIPTION
statusSuccess : Your request processed and found valid details.
Error : When your request has some wrong data.
totalBalanceTotal balance of your account (Main + Utility + AePS Balance)
mainBalanceAvailable balance for recharge / dmt service usage.
aepsBalanceAvailable balance for AePS service purpose.
messageBalance 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

PARAMETERDESCRIPTION
usernameYour registered mobile number with us
api_tokenAPIKEY generated in profile section Get API Token
txn_idUnique ID generated by Deeper Web Technology
reasonYour Message/Remark for that transaction

Response Pramaters List

PARAMETERDESCRIPTION
statusAccepted : Your complain request accepted.
Error : When your request has some wrong data.
messageCUSTOM MESSAGE FROM SERVER
complain_idUNIQUE COMPLAIN ID generated by Deeper Web Technology

Operator Codes

Mobile Operators
OperatorCode
AirtelAT
BSNLBT
BSNL SPECIALBSP
JioJIO
ViVI
DTH Operators
OperatorCode
Airtel DTHATDTH
Dish TVDISHTV
Sun DirectSUNDTH
Tata SkyTATASKY
Videocon D2HVDDTH
Electricity Operators
OperatorCodeFields
Adani Electricity Mumbai LimitedEADANIfield1 : Consumer Number
Ajmer Vidyut Vitran Nigam LtdEAVVNLfield1 : K Number
APEPDCL – Eastern Power Distribution CO AP Ltd.APEPDCLfield1 : Service Number
APSPDCL – Southern Power Distribution CO AP Ltd.APSPDCLfield1 : Service Number
Assam Power Distribution Company LtdEAPDCLfield1 : Consumer ID
Assam Power Distribution Company Ltd (NON-RAPDR)EADPCLNfield1 : Consumer ID
Bangalore Electricity SupplyBESfield1 : Customer ID / Account ID
BESTBESTfield1 : Consumer Number
Bhagalpur Electricity Distribution Company (P) LtdBEDCLfield1 : Account Number
Bharatpur Electricity Services Ltd. (BESL)BESLfield1 : K Number
Bikaner Electricity Supply Limited (BkESL)BKESLfield1 : K Number
Brihan Mumbai Electric Supply And Transport UndertakingBMESTUfield1 : Consumer Number
Brihanmumbai Electric Supply And TransportBESATfield1 : Consumer Number
BSES Rajdhani Power LimitedBSESRfield1 : CA Number
BSES Yamuna Power LimitedBSESYfield1 : CA Number
Calcutta Electricity Supply Ltd (CESC LTD)CESCfield1 : Consumer No
CESU, OdishaCESUfield1 : Consumer Id
Chamundeshwari Electricity Supply Corp Ltd (CESCOM)CESCOMfield1 : Account ID(RAPDRP) OR Consumer No./Connection ID(Non-RAPDRP)
Chandigarh Electricity DepartmentCEDfield1 : Account No without(/)
Chhattisgarh Electricity BoardCEBfield1 : Business Partner Number
Dakshin Gujarat Vij Company LtdDGVCLfield1 : Consumer Number
Dakshin Haryana Bijli Vitran Nigam (DHBVN)DHBVNfield1 : Account Number
field2 : Mobile Number (+91)
field3 : Mobile Number (+91)
Daman and Diu Electricity DepartmentDDEDfield1 : Account number
Department of Power, NagalandDPNfield1 : Consumer ID
Dnh Power Distribution Company LimitedDPDCLfield1 : Service Connection Number
Goa Electricity DepartmentGOAEDfield1 : Contract Account No
Government of Puducherry Electricity DepartmentGPEDfield1 : Consumer Number
field2 : Consumer Type
field3 : Consumer Type
Gulbarga Electricity Supply Company LimitedGESLfield1 : Consumer Number
Himachal Pradesh ElectricityHPEfield1 : Consumer ID
Hubli Electricity Supply Company Ltd (HESCOM)HESCOMfield1 : Account ID(RAPDRP) OR Consumer No./Connection ID(Non-RAPDRP)
India Power Corporation – West BengalIPCWBfield1 : Consumer Number
India Power Corporation LimitedIPCLfield1 : Consumer Number
Jaipur Vidyut Vitran Nigam LtdJVVNLfield1 : K NO
Jammu and Kashmir Power Development DepartmentJKPDDfield1 : Consumer Code
Jamshedpur Utilities and Services CompanyJUSEfield1 : Business Partner Number
Jharkhand Bijli Vitran Nigam Limited (JBVNL)JBVNLfield1 : Consumer Number
field2 : Subdivision Code
Jodhpur Vidyut Vitran Nigam LtdJOVVNLfield1 : K Number
Kanpur Electricity Supply Company Ltd (KESCO)KESCOfield1 : Account Number
Kerala State Electricity Board Ltd. (KSEBL)KSEBLfield1 : Consumer Number
Kota Electricity Distribution Limited (KEDL)KEDLfield1 : K Number
M.p. Madhya Kshetra Vidyut Vitaran – AgricultureMPAGROfield1 : Consumer Number/IVRS ID
M.P. Madhya Kshetra Vidyut Vitaran – RURALMPRURALfield1 : IVRS
M.P. Madhya Kshetra Vidyut Vitaran – URBANMPURBANfield1 : IVRS
M.P. Paschim Kshetra Vidyut VitaranMPPKVVfield1 : Consumer Number
M.P. Poorv Kshetra Vidyut Vitaran – URBANMPPKVUfield1 : Consumer Number/IVRS
M.P. Poorv Kshetra Vidyut Vitaran – RURALMPPKVRfield1 : Consumer Number/IVRS
Madhya Gujarat Vij Company LtdMGVCLfield1 : Consumer Number
Mahavitaran-Maharashtra State Electricity Distribution Company Ltd. (MSEDCL)MSEDCLfield1 : Consumer Number
field2 : Billing Unit
Mangalore Electricity Supply Co. Ltd (MESCOM)MSECOMfield1 : Account ID
Meghalaya Power Distribution Cor. LtdMPDCLfield1 : Consumer ID
MP-Poorv Kshetra Vidyut Vitaran Co. Ltd.(Jabalpur)MPJBLfield1 : Consumer Number/IVRS
Muzaffarpur Vidyut Vitran LimitedMVVLfield1 : Consumer Number
NESCO, OdishaNESCOfield1 : Consumer Number
New Delhi Municipal Council (NDMC) – ElectricityNDMCfield1 : Consumer Number
Noida Power Company LimitedNPCLfield1 : Consumer Number
North Bihar Power Distribution Company Ltd.NBPDCLfield1 : CA Number
Northern Power Distribution Of Telanagana LtdNPDTLfield1 : USC No
Odisha Discoms B2BODIB2Bfield1 : Consumer Number
Odisha Discoms B2CODIB2Cfield1 : Consumer Number
Paschim Gujarat Vij Company LtdPGVCLfield1 : Consumer Number
Power & Electricity Department Government Of MizoramPEDGMfield1 : Consumer Number
Punjab State Power Corporation Ltd (PSPCL)PSPCLfield1 : Account Number
Rajasthan Vidyut Vitran Nigam LimitedRVVNLfield1 : K Number
Sikkim Power – URBANSKMUfield1 : Contract Acc Number
Sikkim Power – RURALSKMRfield1 : Contract Acc Number
South Bihar Power Distribution Company Ltd.SBPDCLfield1 : CA Number
SOUTHCO, OdishaSOUTHCOfield1 : Consumer Number
Tamil Nadu Electricity Board (TNEB)TNEBfield1 : Consumer Number
Tata Power Delhi Distribution LtdTPDDLfield1 : Customer Account Number
Tata Power MumbaiTATAPMfield1 : Consumer Number
Torrent power – AgraTORAGRAfield1 : Service Number
Torrent power – AhmedabadTORAHMfield1 : Service Number
Torrent power – BhiwandiTORBHIfield1 : Service Number
Torrent power – SuratTORSURATfield1 : Service Number
TP Ajmer Distribution Ltd (TPADL)TPADLfield1 : K Number
Tp Center Odisha Distribution LimitedTPCODLfield1 : Consumer Number
Tripura State Electricity BoardTSEBfield1 : Consumer ID
Uttar Gujarat Vij Company LtdUGVCLfield1 : Consumer Number
Uttar Haryana Bijli Vitran Nigam (UHBVN)UHBVNfield1 : Account Number
field2 : Mobile Number (+91)
field3 : Mobile Number (+91)
Uttar Pradesh Power Corp Ltd (UPPCL) – RURALUPPCLRfield1 : Consumer Number
Uttar Pradesh Power Corp. Ltd. (UPPCL) – URBANUPPCLUfield1 : Consumer Number
Uttarakhand Power Corporation LimitedUPCLfield1 : Service Connection Number
WESCO UtilityWESCOUfield1 : Consumer Number
West Bengal State ElectricityWBSEDCLfield1 : Consumer Id
field2 : Registered mobile number
Postpaid Operators
OperatorCode
Airtel PostpaidPA
BSNL PostpaidPB
JIO PostpaidPJIO
VI PostpaidPV
GiftCard Operators
OperatorCodeFields
Google Play CodeGPLAYfield1 : Mobile No

Payment Gateway:

Credit Card:

Banking:

Other’s:

Following my social platform

Webwww.mytechtrips.com
Join telegram channelClick here
Join WhatsApp groupClick here
FacebookClick here
InstagramClick here
Youtube Channel 1Click here
Youtube Channel 2Click here