Vous êtes sur la page 1sur 10

1.

Introduction

1.1 Purpose
This document has been created to explain the Ezypay Prepaid Recharge Applications web
services/http api interface. This is intended for developers, who are developing interface
applications to consume these services to provide various supported services through
Ezypay. The description of the web services can be used by the end users to write other
custom reporting & support applications around Ezypay.

1.2 API Interface:


SOAP: The Ezypay application exposes Service Oriented Architecture (SOA) compliant
web services, which can be consumed by various methods like standard SOAP calls or
HTTP requests etc. There are two categories of web services available with this
version, one intended for Distribution network (franchises/distributors/retailers/3rd party
distribution networks) and for provider (operator, service provider). The former is termed
as Network Web Service & exposes various transaction related methods and the latter
is termed as Provider Web Service & exposes various reconciliation methods &
asynchronous transactions response API.
HTTP Request: The Ezypay application exposes Http API service with Invoking
technology of URL and Query string. Data will be passing to system via HTTP request.

1.3 Revision History

Document Management and Control


Process No 4.0
Template No Ezypay/04
Document No API document for Ezypay
Document Name API Manual
Template
Document Class Restricted 4.0.1
Version
Author Ezypay online services pvt ltd,
Purpose Documenting Functional Requirement of the Project
Validity LifeTime
Doc Ownership Ezypay online services private limited.

Created By Ezypay Online Services Pvt Ltd Page 1 of 10


2. Push Recharge Request. [For Prepaid &Postpaid]
https://api.myezypay.in/Ezypaywebservice/PushRequest.aspx?AuthorisationCode
=5998799662498&product=1&MobileNumber=9435621457&Amount=500&
RequestId=xxxxx&StoreID=xxxx

Summary: This method pushes recharge request to server


Additional SoapHeader: Nil
EnableSession: No
Returns: STRING

Parameters:
Sno Parameter Type Length Description Null- Example
able
1 Authorization Code String 12 Method will accept N/A 5998799662498
authorization code which is
defined at creation time
2 Product Int Not Mention Method will accept product id N/A 1
3 Mobile Number String 14 Method will accept customer N/A 943658452
mobile no.
4 Amount String 14 Method will accept customer N/A 10
recharge amount 0
5 Request ID String 14 Method will accept Request Id Optional 5698
from 3rd party who is calling this 5
API
6 Request ID String 30 Method will accept Store Id Mendatory NA
from 3rd party only for Airtel
Prepaid who is calling this API

Response Interpretation:
Sno Response Interpretation Type, Clause & Example
Resolution

Created By Ezypay Online Services Pvt Ltd Page 2 of 10


1 Txnid~RequestId Txnid : Exypay 12345~RE10111
~MobileNumber~Status registered ID,REquestid: ~9999999999~ 1~
Id~description~Amount Id which comes from Transaction Successful~
~balance~ party,Balance: current 100~500.25~12/02/2013
Date~oprefno balance after last 10:20:23~111111111
transaction,
StatusId:transaction
status in Numeric ,
description:Transaction
status
description,MobileNumb
er: customer mobile no,
Date:
Currentadtetime,Amount
:Recharge
Amount,Balance:Current
Balance,oprefno:Operato
r Tid no

3. Postpaid Push [For Landline]


https://api.myezypay.in/Ezypaywebservice/postpaidpush.aspx?AuthorisationCode
=5998799662498&product=1&MobileNumber=xxxxxxxxxx&Amount=500&
RequestId=xxxxx&Circle=kolkata&AcountNo=55788922554&StdCode=033

Summary: This method enquire details of a previous transaction


Additional SoapHeader: Nil
EnableSession: No
Returns: STRING

Parameters:
Sno Parameter Type Length Description Null- Example
able
1 Authorization Code String 1 Method will accept N/A 5998799662498
2 authorization code which is
defined at creation time
2 Product Int Not Mention Method will accept product id N/A 1
3 Mobile Number String 1 Method will accept customer N/A 943658452
4 mobile no.
4 Amount String 1 Method will accept customer N/A 100
4 recharge amount
5 Request ID String 1 Method will accept Request ID Optional 56985
4 from 3rd party who is calling this
API
6 Circle String 5 Method will accept the circle N/A KOLKATA
0 code for identifying the region

Created By Ezypay Online Services Pvt Ltd Page 3 of 10


7 Account No String 2 Method will accept the N/A 44654847846545
0 Account of user which is
created by operator
8 Std Code String 1 STD code of the region 033
0

Response Interpretation:
Response Interpretation Type, Clause & Example
Resolution
1 Txnid~RequestId Txnid : Exypay 12345~RE10111
~MobileNumber~Status registered ID,REquestid: ~9999999999~ 1~
Id~description~Amount ID which comes from Transaction Successful
~balance~ Date party,Balance: current ~100~500.25~12/02/2013
balance after last 10:20:23
transaction,
StatusID:transaction
status in Numeric ,
description:Transaction
status
description,MobileNumb
er: customer mobile no,
Date:
Currentadtetime,Amount
:Recharge Amount

Created By Ezypay Online Services Pvt Ltd Page 4 of 10


4. Product ID

Mobile RechType Product ID


AIRTEL Top Up 1
AIRCEL Top Up 2
BSNL Top Up 4
BSNL Special 3
LOOP MOBILE Top Up 23
DOCOMO Top Up 15
DOCOMO Special 16
IDEA Top Up 34
MTS Top Up 14
MTNL DEL Top Up 45
MTNL DEL Special 40
MTNL MUM Top Up 11
MTNL MUM Special 44
TATA INDICOM Top Up 17
T24 Top Up 42
T24 Special 43
REL GSM Top Up 18
REL CDMA Top Up 19
UNINOR Top Up 6
UNINOR Special 5

Created By Ezypay Online Services Pvt Ltd Page 5 of 10


VODAFONE Top Up 12
VIDEOCON Top Up 21
VIDEOCON Special 22
DTH RechType Product ID
BIG TV Top Up 20
DISH TV Top Up 7
SUN DIRECT Top Up 8
TATA SKY Top Up 9
VIDEOCON D2H Top Up 13
AIRTEL DTH Top Up 10
Postpaid RechType Product ID
AIRTEL POSTPAID 32
AIRCEL POSTPAID 54
BSNL POSTPAID 31
DOCOMO POSTPAID 52
IDEA POSTPAID 33

Product ID
Postpaid RechType Product ID
MTS POSTPAID 57
REL CDMA POSTPAID 47
REL GSM POSTPAID 59
LOOP MOBILE POSTPAID 50
TATA INDICOM POSTPAID 53
VODAFONE POSTPAID 35
LandLine RechType Product ID
AIRTEL LANDLINE 48
BSNL LANDLINE 56
MTNL LANDLINE 51
RELIANCE LANDLINE 49
TATA INDICOM LANDLINE 53

Created By Ezypay Online Services Pvt Ltd Page 6 of 10


5. Response Codes
Code Description
1 Transaction Successful (Wallet Debit)
100 Transaction Pending (Wallet Debit)
-130 Technical Failure
-131 Invalid Mobile Number
-136 Invalid Amount
-137 Operator Internal Error
-138 Invalid Account Number
-140 Operator System General Failure
-141 Invalid Input details
200 Timeout (Wallet Debit)
-1600 Invalid Product ID
-1601 Operator not match
-1602 Invalid Authorisation code
-1603 Invalid Operator
-1604 Invalid Amount
-1605 Insufficient balance
-1608 Internal Error
-1609 Unknown Error
-1610 Invalid IP address
-1611 Duplicate request,please try after 10 minutes
-1612 Currently operator is down,please try after sometime

Created By Ezypay Online Services Pvt Ltd Page 7 of 10


-1613 Operator is not available for this Circle
-1614 Invalid Denomination
-1615 Requested ID is not Unique
-1616 Invalid Customer VC Number
-1617 Inactive VC not allowed below 250

6. Get Balance
https://api.myezypay.in/Ezypaywebservice/GetBalance.aspx?AuthorisationCode=5998799662498

Summary: This method retrieves the current balance of the Retailer


Additional SoapHeader: Nil
EnableSession: No
Returns: STRING

Parameters:
Sno Parameter Type Length Description Null- Example
able
1 AuthorisationC String 12 Method will accept N/A 5998799662498
ode authorization which is defined
at creation time

Response Interpretation:
Sno Response Interpretation Type, Cause & Example
Resolution
1 Current Current Balance Agent 500~10/02/2013 10:12 AM
Balance~Current current wallet balance
Datetime

Created By Ezypay Online Services Pvt Ltd Page 8 of 10


7. Transaction Enquiry

https://api.myezypay.in/Ezypaywebservice/TransactionEnquiry.aspx?AuthorisationCode=5998799662498&
RequestID =1264

Summary: This method enquire details of a previous transaction


Additional SoapHeader: Nil
EnableSession: No
Returns: STRING

Parameters:
Null-
Sno. Parameter Type Length Description Example
able
Method will accept
Authorization
1 string 12 authorization code which is N/A 5998799662498
Code
defined at creation time
Method will return ReqID to
2 RequestID string 14 3rd party who is calling this N/A 56985
API

Response Interpretation:
Sn Type, Cause &
Response Interpretation Example
o Resolution

Created By Ezypay Online Services Pvt Ltd Page 9 of 10


1 <ResponseRechargeInfo> Status: Status of <ResponseRechargeInfo>
<sOperator> previous txn, <sOperator>
<RequestID></RequestID> Description: <RequestID>264040</RequestID>
<ResponseID></ResponseI Description of <ResponseID>264040</ResponseID
D> Status, RequestID: >
<MobileNumber></Mobile Request Id of 3rd <MobileNumber>9622370716</Mo
Number> party, ResponseID: bileNumber>
<Status></Status> ID of Ezypay, <Status>1</Status>
<Description>Transaction MobileNumber:Cu <Description>Transaction
Successful</Description> stomer mobile no. Successful</Description>
<ResponseTime></Respon <ResponseTime></ResponseTime>
seTime> <Name> </Name> <Name>TEST RETAILER</Name>
</sOperator> </sOperator>
</ResponseRechargeInfo </ResponseRechargeInfo>

Important Notes

Time Out Limits:-


Kindly keep the overall time out is 200 seconds at your end .

Clarification on the Transaction Query API


Kindly note that transaction query API can be called after 30 minutes of the transaction only, still
there will be chances that the transaction status may show time out or pending or the status will
remain same as it is. You need to show the same transaction as success and deduct the payment
from your merchants wallet until you get a clear response in the query API either Success of Failed

Following response code and Description will show incase of invalid input during trans
query..
-1100: Vendor Request ID not Supplied
-1900: Please make your txn enquiry after 5 (mins)
-1300: Request ID not found in system
-10000: Unknown

Created By Ezypay Online Services Pvt Ltd Page 10 of 10