2018

TECHNICAL DOCUMENT FOR

RECHARGE & BBPS SERVICES

VERSION 1.2
ISSUED BY: AMBIKA RECHARGE SOLUTION PVT. LTD. (DEPARTMENT OF IT)

AMBIKA RECHARGE SOLUTION PVT. LTD. | BEED

Transaction API (For Prepaid,Postpaid DTH & Landline)
Request URL

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}

Request Parameter Response Parameter

Parameter Required Description <XMLRESPONSE>
UserID MANDATORY User Id <STATUS>SUCCESS</STATUS>
{Given by <MOBILE>9876543210</MOBILE>
Ambika } <AMOUNT>200</AMOUNT>
Token MANDATORY From API <RPID>1812717369443993A</RPID>
User menu
SPKey MANDATORY SP KEY <AGENTID>18127173727857BC70</AGENTID>
{FROM <OPID>3567686556</OPID>
SLAB <BAL>3884.86</BAL>
DETAIL <MSG>SUCCESS</MSG>
SECTION IN </XMLRESPONSE>
PORTAL}
Account MANDATORY Account No
to be
recharged
Amount MANDATORY Amount of
recharge
APIRequestID MANDATORY Unique API
request ID
Optional1 {Optional1}
Optional2 {Optional2}
Optional3 {Optional3}
Optional4 {Optional4}
OutletID UserID
Format 1-for JSON
/2-for XML
Status Check API
Request URL

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'

Request Parameter Response Parameter

Parameters Description <XMLRESPONSE>

<STATUS>SUCCESS</STATUS>
UserID User Id {Given by ambika}
<MOBILE>9876543210</MOBILE>
Token From API User menu <AMOUNT>200</AMOUNT>
AgentID UNIQUE AGENT TRANSACTION <RPID>1812717369443993A</RPID>
ID
RPID Ambika UNIQUE <AGENTID>18127173727857BC70</AGENTI
TRANSACTION ID D>
Format 1-for JSON /2-for XML <OPID>3567686556</OPID>
<BAL>3884.86</BAL>
<MSG>DISPUTE STATUS</MSG>
</XMLRESPONSE>

Balance check API

Request URL

https://ambikaecom.net/API/Balance?UserID={UserID}&Token={Token}&Format={Format}

Request Parameter Response Parameter

<STATUS>SUCCESS</STATUS>
Parameter Required Description <MSG> STATUS</MSG>
UserID MANDATORY User Id(Given by <BAL>100.86</BAL>
ambika)
Token From API User
menu
Format 1-for JSON /2-for
XML
Refund Request API
Request URL

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

Sample Callback URL

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}"}

RESPONSE:{”mobileNo”: “1234567890”,”refID”: “REF0AS2002”,”otpStatus”:

“REQUIRED”,”STATUS”: “SUCCESS”,”MSG”: “An OTP has been sent to outlet
mobile number or Outlet exists!”}

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”: “[email protected]”,”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

Service name Bill Billing TDS Description

Fetch model
Reliance Energy Yes P2A Yes pass Consumer Number (9 digits) in '{Account}' and Cycle
Number (2 digits) in '{Optional1}'
BSES Rajdhani Power Yes P2A Yes pass CA Number (9 digits) in '{Account}'
Limited
BSES Yamuna Power Yes P2A Yes pass CA Number (9 digits) in '{Account}'
Limited
TATA Power-Delhi Yes P2A Yes pass CA Number (11-12 digits) in '{Account}'
MSEDC Limited Yes P2A Yes pass Consumer Number (12 digits) in '{Account}', Billing Unit (4
digits) in '{Optional1}'
Torrent Power - Agra Yes P2A Yes pass Service Number (upto 15 digits) in '{Account}' and City
Name (Pass Agra) in '{Optional1}'
Brihan Mumbai Yes P2A Yes pass Consumer Number (10 digits) in '{Account}'
Electric Supply and
Transport
Undertaking
Noida Power Yes P2A Yes pass Consumer Number (10 digits) in '{Account}'
Company Limited
Tripura State Yes P2A Yes pass Consumer ID (upto 12 digits) in '{Account}'
Electricity
Corporation Ltd
Madhya Pradesh Yes P2A Yes pass Costumer Number (10 digits) in '{Account}'
Paschim Kshetra
Vidyut Vitaran -
Indore
Jamshedpur Utilities Yes P2A Yes pass Business Partner Number (6-10 alphanumerics) in
and Services '{Account}'
Company Limited
India Power Yes P2A Yes pass Consumer Number (10-12 alphanumerics) in '{Account}'
Corporation Limited
- Bihar
Chhattisgarh State Yes P2A Yes pass Business Partner Number (10 digits) in '{Account}'
Electricity Board
Calcutta Electricity Yes P2A Yes pass Customer ID (11 digits) in '{Account}'
Supply Ltd (CESC)
Bangalore Electricity Yes P2A Yes pass Customer ID / Account ID (upto 10 digits) in '{Account}'
Supply Company
APDCL - ASSAM Yes P2A Yes pass Consumer ID (11-12 digits) in '{Account}'
Ajmer Vidyut Vitran Yes P2A Yes pass K Number (12 digits) in '{Account}'
Nigam Limited
(AVVNL)
Bharatpur Electricity Yes P2A Yes pass K Number (12 alphanumerics) in '{Account}'
Services Ltd. (BESL)
Bikaner Electricity Yes P2A Yes pass K Number (12 digits) in '{Account}'
Supply Limited
(BKESL)
Daman and Diu Yes P2A Yes pass Account number (1-6 digits) in '{Account}'
Electricity
DGVCL - GUJARAT No P2A Yes pass Consumer Number (5-11 digits) in '{Account}'
DNH Power Yes P2A Yes pass Service Connection Number (1-20 alphanumerics) in
Distribution '{Account}'
Company Limited
APEPDCL-Eastern Yes P2A Yes pass Service Number (8-20 alphanumerics) in '{Account}'
Power Distribution
CO AP Ltd
Gulbarga Electricity Yes P2A Yes pass Consumer Number (10 digits) in '{Account}'
Supply Company
Limited (GESCOM)
India Power Yes P2A Yes pass Consumer Number (10-12 digits) in '{Account}'
Corporation - West
Bengal
Jodhpur Vidyut Yes P2A Yes pass K Number (12 digits) in '{Account}'
Vitran Nigam Limited
(JDVVNL)
Jaipur Vidyut Vitran Yes P2A Yes pass K Number (12 digits) in '{Account}'
Nigam (JVVNL)
Kota Electricity Yes P2A Yes pass K Number (12 digits) in '{Account}'
Distribution Limited
(KEDL)
Madhya Gujarat Vij No P2A Yes pass Consumer Number (5-11 digits) in '{Account}'
Company Limited
(MGVCL)
Meghalaya Power Yes P2A Yes pass Consumer ID (upto 12 digits) in '{Account}'
Dist Corp Ltd
Muzaffarpur Vidyut Yes P2A Yes pass Consumer No (10-12 digits) in '{Account}'
Vitran Limited
North Bihar Power Yes P2A Yes pass CA Number (9-11 digits) in '{Account}'
Distribution
Company Ltd.
NESCO, Odisha Yes P2A Yes pass Consumer Number (12 digits) in '{Account}'
Paschim Gujarat Vij No P2A Yes pass Consumer Number (5-11 digits) in '{Account}'
Company Limited
(PGVCL)
South Bihar Power Yes P2A Yes pass CA Number (9-11 digits) in '{Account}'
Distribution
Company Ltd.
SNDL Nagpur Yes P2A Yes pass Consumer No (10-12 digits) in '{Account}'
SOUTHCO, Odisha Yes P2A Yes pass Consumer Number (12 digits) in '{Account}'
APSPDCL-Southern Yes P2A Yes pass Service Number (9-13 digits) in '{Account}'
Power Distribution
CO AP Ltd
Tamil Nadu Yes P2A Yes pass Consumer Number (upto 18 alphanumerics) in '{Account}'
Electricity Board
(TNEB)
TP Ajmer Yes P2A Yes pass K Number (12 digits) in '{Account}'
Distribution Ltd
(TPADL)
Uttar Gujarat Vij No P2A Yes pass Consumer Number (5-11 digits) in '{Account}'
Company Limited
(UGVCL)
Uttarakhand Power Yes P2A Yes pass Service Connection Number (13 alphanumerics) in
Corporation Limited '{Account}', Address (alphanumeric) in '{Optional1}', Bill Year
(numeric) in '{Optional2}', Bill Month (numeric) in
'{Optional3}',Biller Transaction Id (alphanumeric) in '{Optional4}'

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

BBPS Bill Billing

Service name Enabled Fetch model TDS Description
pass Customer Account Number (12 digits) in
'{Account}' and Bill Group number(upto 8 digits)
Mahanagar Gas Yes Yes P2A Yes in '{Optional1}'
Indraprastha Gas Yes Yes P2A Yes pass BP Number (10 digits) in '{Account}'
pass Customer Account Number (upto 15 digits)
Gujarat Gas Limited Yes Yes P2A Yes in '{Account}'
Adani Gas - Gujarat Yes Yes P2A Yes pass Customer ID (10 digits) in '{Account}'
Adani Gas - Haryana Yes Yes P2A Yes pass Customer ID (10 digits) in '{Account}'
Haryana City Gas Yes Yes P2A Yes pass CRN Number (10 digits) in '{Account}'
Sabarmati Gas Limited
(SGL) Yes Yes P2A Yes pass Customer ID (10 to 12 digits) in '{Account}'
Siti Energy - Uttar Pradesh Yes Yes P2A Yes pass ARN Number (7 to 9 digits) in '{Account}'
pass Consumer Number (1 to 20 digits) in
Tripura Natural Gas Yes Yes P2A Yes '{Account}'
Vadodara Gas Limited Yes Yes P2A Yes pass Consumer Number (7 digits) in '{Account}'
Gail Gas Limited Yes Yes P2A Yes pass BP NO (10 digits) in '{Account}'
pass Customer No (10 to 15 alphanumeric) in
Aavantika Gas Ltd. Yes Yes P2A Yes '{Account}'
pass Customer Number (1 to 5 digits) in
Charotar Gas Limited Yes Yes P2A Yes '{Account}'

DESCRIPTION WATER
Use Same parameters For Bill Fetch Api

BBPS Bill Billing

Service name Enabled Fetch model TDS Description
Delhi Jal Board Yes Yes P2A Yes pass K Number (10 digits) in '{Account}'
Municipal Corporation pass K Number (7 to 20 digits) in '{Account}', Mobile Number in
of Gurugram Yes Yes P2A Yes '{Optional1}' and Email id in '{Optional2}'
Urban Improvement
Trust (UIT) - Bhiwadi Yes Yes P2A Yes pass Customer ID (3 to 20 digits) in '{Account}'
Uttarakhand Jal
Sansthan Yes Yes P2A Yes pass Consumer Number (Last 7 digits) in '{Account}'
Municipal Corporation pass Account No (1 to 9 digits) in '{Account}', Mobile Number in
Jalandhar Yes Yes P2A Yes '{Optional1}' and Email id in '{Optional2}'
Muncipal Coporation pass Consumer Number (1 to 10 digits) in '{Account}', Mobile
Ludhiana Yes Yes P2A Yes Number in '{Optional1}' and Email id in '{Optional2}'

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

Money Transfer Service API

BaseURL- https://ambikaecom.net/
Request Metod -POST

Common Parameter Info

userID- UserID for authentication
token- Token for authentication
format- 1 for JSON, 2 for XML
otpType- sender, beneficiary
transactionMode-IMPS, NEFT
otpStatus-REQUIRED, NOT REQUIRED

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": "[email protected]",
"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":"[email protected]",
"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": "[email protected]",
"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!"
}