Professional Documents
Culture Documents
VERSION 1.2
ISSUED BY: AMBIKA RECHARGE SOLUTION PVT. LTD. (DEPARTMENT OF IT)
https://ambikaecom.net/API/TransactionAPI?
UserID={UserID}&Token={Token}&SPKey={SPKey}&Account={Account}&Amount={Amount}&APIRequestID={
APIRequestID}&Optional1={Optional1}&Optional2={Optional2}&Optional3={Optional3}&Optional4={Optional4
}&OutletID={OutletID}&Format={Format}
https://ambikaecom.net/API/StatusCheck?UserID={UserID}&Token={Token}&RPID={RPID}&AgentID={AgentI
D}&Optional1={Optional1}&Format={Format}
Note:- Optional1 should be in 'dd MMM yyyy' e.g. '01 Jan 2018'
https://ambikaecom.net/API/Balance?UserID={UserID}&Token={Token}&Format={Format}
https://ambikaecom.net/API/RefundRequest?UserID={UserID}&Token={Token}&RPID={RPID}&Format={Format}
REQUEST PARAMETERS
Parameter Description
UserID User Id {Given by Ambika}
Token From API User menu
AgentID UNIQUE AGENT TRANSACTION ID
RPID Ambika UNIQUE TRANSACTION ID
Format 1-for JSON /2-for XML
http://domain_name/API_Response.asmx/yourname_UpdateByID?status={STATUS}&mobile={MOBILE}&am
ount={AMOUNT}&rpid={TRANID}&agentid={AGENTID}&opid={LIVEID}&msg={MSG}
BBPS API
----------------------------------------------------------------------------------------------
1.BillFetch ( Outlet Id(Api Login Id) & Bill Fetch Is Mandatory For All BBPS Transaction)
REQUEST:
https://ambikaecom.net/API/BillFetch?UserID={UserID}&Token={Token}&SPKey={SPKe
y}&Account={Account}&APIRequestID={APIRequestID}&Optional1={Optional1}&Option
al2={Optional2}&Optional3={Optional3}&Optional4={Optional4}&OutletID={OutletID}
&Format={Format}
RESPONSE:
{"Account":"{Account}","AGENTID":"{AGENTID}","AMOUNT":"{AMOUNT}","CustomerNa
me":"{CustomerName}","DueAmount":"{DueAmount}","BillDate":"{BillDate}","BillNumb
er":"{BillNumber}","BillPeriod":"{BillPeriod}","RefID":"{RefID}","STATUS":"{STATUS}","
MSG": "{MSG}"}
2. TransactionAPI
REQUEST:
https://ambikaecom.net/API/TransactionAPI?UserID={UserID}&Token={Token}&SPKey=
{SPKey}&Account={Account}&Amount={Amount}&APIRequestID={APIRequestID}&Opti
onal1={Optional1}&Optional2={Optional2}&Optional3={Optional3}&Optional4={Option
al4}&OutletID={OutletID}&RefID={RefID}&Format={Format}
RESPONSE:
{"Account":"{Account}","AGENTID":"{AGENTID}","AMOUNT":"{AMOUNT}","CustomerNa
me":"{CustomerName}","DueAmount":"{DueAmount}","BillDate":"{BillDate}","BillNumb
er":"{BillNumber}","BillPeriod":"{BillPeriod}","RefID":"{RefID}","STATUS":"{STATUS}","
MSG": "{MSG}"}
Outlet API
----------------------------------------------------------------------------------------------
1. Outlet/Verify Outlet
(POST) [Body→raw→application/json]
REQUEST:
https://ambikaecom.net/API/Outlet/VerifyOutlet
{"userID":"{userID}","token":"{token}","format":"{format}","mobileNo":"{mobileNo}"}
2. Outlet/Register
(POST) [Body→raw→application/json]
REQUEST:
https://ambikaecom.net/API/Outlet/Register
{"userID":"{userID}","token":"{token}","format":"{format}","name":"{name}","compa
ny":"{company}","mobileNo":"{mobileNo},"emailID":"{emailID}","pincode":"{pincode}"
,"address":"{address}","pan":"{pan}","aadhar":"{aadhar}","oType":"{oType}","OTP”:"{OTP}","RefID":"{RefID}"}
RESPONSE:
{”outletID”: 10000, “name”: “Test”,”company”: “Company”,”mobileNo”:
“1234567890”,”emailID”: “test@test.in”,”pincode”: “226026”,”address”: “beed”,”pan”:
“AELPU5278H”,”aadhar”: “123456789012”,”kycStatus”: “NOT UPLOADED”,”verifyStatus”:
“REQUESTED”,”activeStatus”: “Active”,”oType”: “STORE”,”STATUS”: “SUCCESS”,”MSG”:
“Outlet has been registered successfully!” }
3. Outlet/UploadKYC
(POST) [Body→raw→application/json]
REQUEST:
https://ambikaecom.net/API/Outlet/ UploadKYC
{"userID":"{userID}","token":"{token}","format":"{format}","outletID":"{outletID}","ky
c":[{"docTypeID":"{docTypeID}","fileName":"{fileName}","link":"{link}"}]}
RESPONSE:
{"kycDocs": [{"docTypeID": 1,"docName": "PAN Card","isMandatory": true,"verifyStatus":
"NOT VERIFIED"},{"docTypeID": 2,"docName": "Aadhaar Card","isMandatory":
true,"verifyStatus": "NOT VERIFIED"},{"docTypeID": 3,"docName":"Photo (Passport
Size)","isMandatory": true,"verifyStatus": "NOT VERIFIED"},{"docTypeID": 4,"docName":
"Service Agreement","isMandatory": false,"verifyStatus": "NOT
UPLOADED"},{"docTypeID": 5,"docName": "GST Registration","isMandatory":
false,"verifyStatus": "NOT UPLOADED"},{"docTypeID": 6,"docName": "Cancelled
Cheque","isMandatory": false,"verifyStatus": "NOT UPLOADED"},{"docTypeID":
7,"docName": "Business Address Proof","isMandatory":false,"verifyStatus": "NOT
UPLOADED"}],"STATUS": "SUCCESS","MSG": "Request Accepted"}
4. Outlet/GetKYC
(POST) [Body→raw→application/json]
REQUEST:
https://ambikaecom.net/API/Outlet/G etKYC
{"userID":"{userID}","token":"{token}","format":"{format}","outletID":"{outletID}"}
RESPONSE:
{"kycDocs": [{"docTypeID": 1,"docName": "PAN Card","isMandatory": true,"verifyStatus":
"NOT VERIFIED"},{"docTypeID": 2,"docName": "Aadhaar Card","isMandatory":
true,"verifyStatus": "NOT VERIFIED"},{"docTypeID": 3,"docName":"Photo (Passport
Size)","isMandatory": true,"verifyStatus": "NOT VERIFIED"},{"docTypeID": 4,"docName":
"Service Agreement","isMandatory": false,"verifyStatus": "NOT
UPLOADED"},{"docTypeID": 5,"docName": "GST Registration","isMandatory":
false,"verifyStatus": "NOT UPLOADED"},{"docTypeID": 6,"docName": "Cancelled
Cheque","isMandatory": false,"verifyStatus": "NOT UPLOADED"},{"docTypeID":
7,"docName": "Business Address Proof","isMandatory":false,"verifyStatus": "NOT
UPLOADED"}],"STATUS": "SUCCESS","MSG": ""}
DESCRIPTION ELECTRICITY
Use Same parameters For Bill Fetch Api
Uttar Pradesh Power Yes P2A Yes pass Consumer Number (10-12 digits) in '{Account}'
Corp Ltd (UPPCL) -
URBAN
Uttar Pradesh Power Yes P2A Yes pass Consumer Number (10-12 digits) in '{Account}'
Corp Ltd (UPPCL) -
RURAL
WESCO Utility Yes P2A Yes pass Consumer Number (12 digits) in '{Account}'
Dakshin Haryana Bijli Yes P2A Yes pass Account Number (9-12 alphanumeric) in '{Account}',
Vitran Nigam Mobile Number (10 digits) in '{Optional1}'
(DHBVN)
Hubli Electricity Yes P2A Yes pass Account ID OR Consumer Number (5-10 digits) in
Supply Company Ltd '{Account}'
(HESCOM) - RAPDRP
Hubli Electricity Yes P2A Yes pass Connection ID (5-10 digits) in '{Account}'
Supply Company Ltd
(HESCOM) - Non-
RAPDRP
Uttar Haryana Bijli Yes P2A Yes pass Account Number (10-12 alphanumeric) in '{Account}',
Vitran Nigam Mobile Number (10 digits) in '{Optional1}'
(UHBVN)
Chamundeshwari Yes P2A Yes pass Account ID or Consumer Number (10 alphanumeric) in
Electricity Supply '{Account}'
Corp Ltd (CESCOM) -
RAPDRP
Chamundeshwari Yes P2A Yes pass Connection ID (10 alphanumeric) in '{Account}'
Electricity Supply
Corp Ltd (CESCOM) -
Non-RAPDRP
Himachal Pradesh Yes P2A Yes pass K Number (10-12 digits) in '{Account}'
State Electricity
Board (HPSEB)
Jharkhand Bijli Vitran Yes P2A Yes pass Consumer Number (3-15 alphanumeric) in '{Account}',
Nigam Ltd (JBVNL) Subdivision Code (1-3 digits) in '{Optional1}'
West Bengal State Yes P2A Yes pass Consumer ID (9 digits) in '{Account}'
Electricity
Distribution Co. Ltd
(WBSEDCL)
Torrent Power - Yes P2A Yes pass Service Number (upto 15 digits) in '{Account}' and City
Ahmedabad Name (Pass Ahmedabad) in '{Optional1}'
Torrent Power - Yes P2A Yes pass Service Number (upto 15 digits) in '{Account}'
Bhiwandi
Torrent Power - Yes P2A Yes pass Service Number (upto 15 digits) in '{Account}' and City
Surat Name (Pass Surat) in '{Optional1}'
DESCRIPTION LANDLINE
BILLING BILL
SERVICE NAME TDS API PARAMETERS
MODEL FETCH
pass Landline Number in '{Account}' and
Airtel P2A Yes No
STD Code in '{Optional1}'
pass Landline Number in '{Account}',STD
BSNL P2A Yes No Code in '{Optional1}',Account Number in
'{Optional2}' and LLI/LLC in '{Optional3}'
pass Landline Number in '{Account}' and
MTNL - Delhi P2A Yes No
CA Number in '{Optional1}'
MTNL - pass Landline Number in '{Account}' and
P2A Yes No
Mumbai Account Number in '{Optional1}'
pass Landline Number in '{Account}' and
Tata Docomo P2A Yes No
STD Code in '{Optional1}'
DESCRIPTION BROADBAND
Use Same parameters For Bill Fetch Api
BBPS Bill
Service name Enabled Fetch TDS Description
pass Service ID (10 digit) in '{Account}', Status in '{Optional1}',
Tikona Broadband Yes Yes Yes Reason in '{Optional2}' and TDN Transaction Id in '{Optional3}'
Connect Broadband Yes Yes Yes pass Directory Number (4 to 11 digit) in '{Account}'
Hathway Broadband Yes Yes Yes pass Customer ID (9 to 15 digit) in '{Account}'
ACT Fibernet
Broadband Yes Yes Yes pass Account Number/User Name (1 to 50 digit) in '{Account}'
DESCRIPTION GAS
Use Same parameters For Bill Fetch Api
DESCRIPTION WATER
Use Same parameters For Bill Fetch Api
Indore Municipal
Corporation Yes Yes P2A Yes pass Service Number (6 to 15 digits) in '{Account}'
Jabalpur Municipal
Corporation Yes Yes P2A Yes pass Service Number (6 to 15 digits) in '{Account}'
Ranchi Municipal
Corporation Yes Yes P2A Yes pass Consumer No (6 to 25 digits) in '{Account}'
Surat Municipal
Corporation Yes Yes P2A Yes pass Connection Number (1 to 20 alphanumeric) in '{Account}'
Bangalore Water Supply Yes Yes P2A Yes pass RR Number (8 alphanumeric) in '{Account}'
Money Transfer Service API
BaseURL- https://ambikaecom.net/
Request Metod -POST
1. API/DMT/CheckSender
Request URL- API/DMT/CheckSender
Request Parameter
{"userID":"{{userID}}","token":"{{token}}","format":"{{format}}"
,"mobileNo":"{{mobileNo}}","outletID":"{{outletID}}"}
JsonResponse
{"senderNo":"1234567890","name":"ABC
Name","mobileNo":"1234567890","pincode":" ","kycStatus":"KYC Not
Verified","totalLimit":50000.0,"availableLimit":50000.0,"verifyStatus":"VERIFIED",
"STATUS":"SUCCESS","MSG":"Sender Found"}
2. API/DMT/GetBeneficiaries
Request URL- API/DMT/GetBeneficiaries
Request Parameter
{"userID":"{{userID}}","token":"{{token}}","format":"{{format}}"
,"mobileNo":"{{mobileNo}}","outletID":"{{outletID}}"}
JsonResponse
{"STATUS":"SUCCESS","MSG":"BeneList","beneficiaries":[{"beneID":
"A87456","accountNo":"174565478212","beneName":"Keshav","bankNam
e":"Allahabad Bank","ifsc":"ALD7845"}]}
3.API/DMT/CreateSender
Request URL- API/DMT/CreateSender
Request Parameter
{"userID":"{{userID}}","token":"{{token}}","format":"{{format}}"
,"mobileNo":"{{mobileNo}}","name":"{{name}}","pincode":"{{pincod
e}}","outletID":"{{outletID}}"}
API Document Version 1.2
JsonResponse
{"STATUS":"SUCCESS","MSG":"Sender registered
successfully","otpStatus":"NOT REQUIRED"}
4.API/DMT/VerifyOTP
Request URL- API/DMT/VerifyOTP
Request Parameter
{"userID":"{{userID}}","token":"{{token}}","format":"{{format}}"
,"SenderNo":"{{SenderNo}}","otp":"{{otp}}","outletID":"{{outletI
D}}"}
JsonResponse
{"STATUS":"SUCCESS","MSG":"Sender verified successfully"}
5.API/DMT/ResendOTP
Request URL- API/DMT/ResendOTP
Request Parameter
{"userID":"{{userID}}","token":"{{token}}","format":"{{format}}"
,"SenderNo":"{{SenderNo}}","otpType":"{{otpType}}","beneId":"{{b
eneId}}","outletID":"{{outletID}}"}
JsonResponse
{"STATUS":"SUCCESS","MSG":"OTP resent for sender creation"}
6.API/DMT/BeneficiaryRegistration
Request URL- API/DMT/BeneficiaryRegistration
Request Parameter
{"userID":"{{userID}}","token":"{{token}}","format":"{{format}}"
,"mobileNo":"{{mobileNo}}","SenderNo":"{{senderNo}}","beneficiar
yName":"{{beneficiaryName}}","BeneficiaryAccountNo":"{{beneficia
ryAccount}}","BeneficiaryBankCode":"{{beneficiaryBankCode}}","be
neficiaryBankIFSC":"{{beneficiaryBankIFSC}}","outletID":"{{outle
tID}}"}
JsonResponse
{"STATUS":"SUCCESS","MSG":"Beneficiary registered successfully!
Validate beneficiary
required!","otpStatus":"REQUIRED","beneID":"I5462221"}
7.API/DMT/VerifyBeneficiaryOTP
Request URL- API/DMT/VerifyBeneficiaryOTP
Request Parameter
API Document Version 1.2
{"userID":"{{userID}}","token":"{{token}}","format":"{{format}}"
,"mobileNo":"{{mobileNo}}","SenderNo":"{{senderNo}}","beneId":"{
{beneId}}","otp":"{{otp}}","otpType":"{{otpType}}"}
JsonResponse
{"STATUS":"SUCCESS","MSG":"OTP verified successfully!"}
8.API/DMT/RemoveBeneficiary
Request URL- API/DMT/RemoveBeneficiary
Request Parameter
{"userID":"{{userID}}","token":"{{token}}","format":"{{format}}"
,"SenderNo":"{{senderNo}}","beneId":"{{beneId}}","otp":"{{otpOpt
ional}}","outletID":"{{outletID}}"}
9.API/DMT/VerifyBeneficiaryAccount
Request URL- API/DMT/VerifyBeneficiaryAccount
Request Parameter
{"userID":"{{userID}}","token":"{{token}}","format":"{{format}}"
,"SenderNo":"{{mobileNo}}","beneficiaryAccountNo":"{{beneficiary
AccountNo}}","beneficiaryBankIFSC":"{{beneficiaryBankIFSC}}","Ba
nkId":"{{BankID}}","outletID":"{{outletID}}","apiRequestID":"{{a
piRequestID"}
JsonResponse
{"STATUS":"SUCCESS","MSG":"Account verified
successfully!","RPID":"T1820125666658ED5","OPID":"A58D8889F244",
"BeneficiaryName":"Prashant","BAL":15245.24,"ACCOUNT":"","AGENTI
D":"Req781541","AMOUNT":1}
10.API/DMT/ Transfer
Request URL- API/DMT/Transfer
Request Parameter
{"userID":"{{userID}}","token":"{{token}}","format":"{{format}}"
,"BeneficiaryAccountNo":"{{beneficiaryAccountNo}}","SenderNo":"{
{senderNo}}","beneId":"{{beneId}}","amount":"{{amount}}","transa
ctionMode":"{{transactionMode}}","outletID":"{{outletID}}","apiR
equestID":"{{apiRequestID"}
JsonResponse
{"STATUS":"SUCCESS","MSG":"Account verified
successfully!","RPID":"T1820125666658ED5","OPID":"A58D8889F244",
"BeneficiaryName":"Prashant","BAL":15245.24,"ACCOUNT":"646465454
","AGENTID":"Req781541","AMOUNT":1}
API Document Version 1.2
11.API/DMT/ Status
Request URL- API/DMT/Status
Request Parameter
{"userID":"{{userID}}","token":"{{token}}","format":"{{format}}"
,"AgentID":"{{AgentID}}","RPID":"{{RPID}}","Optional1":"{{Transa
ctionDate}}"}
JsonResponse
{"STATUS":"SUCCESS","MSG":"Transaction
Successfull!","RPID":"T1820125666658ED5","OPID":"A58D8889F244","
BAL":15245.24,"MOBILE":"646465454","AGENTID":"Req781541","AMOUNT
":1}
12.API/DMT/ RefundOTP
Request URL- API/DMT/RefundOTP
Request Parameter
{"userID":"{{userID}}","token":"{{token}}","format":"{{format}}"
,"RPID":"{{RPID}}","outletID":"{{outletID}}"}
JsonResponse
{"STATUS":"SUCCESS","MSG":"An OTP has been sent for refund!"}
13.API/DMT/ DMRRefund
Request URL- API/DMT/DMRRefund
Request Parameter
{"userID":"{{userID}}","token":"{{token}}","format":"{{format}}"
,"RPID":"{{RPID}}","otp":"{{otp}}","outletID":"{{outletID}}"}
JsonResponse
{"STATUS":"SUCCESS","MSG":"Refund has been
done!","IsRefunded":true}
OUTLETAPI
1.API/Outlet/VerifyOutlet
Request:
https://ambikaecom.net/API/Outlet/VerifyOutlet
{
API Document Version 1.2
"userID":10009,
"token":"be01ba9b4bc734a522a910f2b1881e8b",
"format":1,
"mobileNo":"1234567890"
}
Response: //(If outlet not registered)
{
"mobileNo": "1234567890",
"refID": "REF0AS2002",
"otpStatus": "REQUIRED",
"STATUS": "SUCCESS",
"MSG": "An OTP has been sent to outlet mobile number"
}
//If exists
{
"outletID": 10001,
"name": "Test",
"company": "Company",
"mobileNo": "1234567890",
"emailID": "test@test.in",
"pincode": "226026",
"address": "Shivaji Nagar, Beed, Maharashtra",
"pan": "AELPU5278H",
"aadhar": "123456789012",
"kycStatus": "REQUESTED",
"verifyStatus": "REQUESTED",
"activeStatus": "Active",
"oType": "STORE",
"otpStatus": "NOT REQUIRED",
"STATUS": "SUCCESS",
"MSG": "Outlet exists!"
}
Request: https://ambikaecom.net/API/
Outlet/Register
{
"userID":10009,
"token":"be01ba9b4bc734a522a910f2b1881e8b",
"format":1,
"mobileNo":"1234567890",
API Document Version 1.2
"name":"Test",
"company":"Company",
"emailID":"test@test.in",
"pincode":"226026",
"address":"Shivaji Nagar, Beed, Maharashtra",
"pan":"AELPU5278H", "aadhar":"123456789012",
"oType":"STORE",
"otp":"653620",
"refID":"REF0AS2002"
}
Response:
{
"outletID": 10000,
"name": "Test",
"company": "Company",
"mobileNo": "1234567890",
"emailID": "test@test.in",
"pincode": "226026",
"address": "Shivaji Nagar, Beed, Maharashtra",
"pan": "AELPU5278H",
"aadhar": "123456789012",
"kycStatus": "NOT UPLOADED",
"verifyStatus": "REQUESTED",
"activeStatus": "Active",
"oType": "STORE",
"STATUS": "SUCCESS",
"MSG": "Outlet has been registered successfully!"
}