1.
Introduction 1.1
Purpose This document has been created to explain the Ezypay Prepaid Recharge Application ’s 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 be consumed by various methods like standard SOAP calls or HTTP requests etc. There are two t wo categories of web services ser vices available with this version, one intended for Distribution network (franchises/distributors/retailers/3 rd party distribution networks) and for provider (operator, service provider). The former is termed as “Network Web Servi ce” & 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 Query string. Data will be passing to system via HTTP request.
1.3
Revision History Document Management and Control
Process No Template No Document No Document Name
4.0 Ezypay/04 API document for Ezypay API Manual
Document Class
Restricted
Author Purpose Validity Doc Ownership
Ezypay online services pvt ltd, Documenting Functional Requirement of the Project LifeTime Ezypay online services private limited.
C Creat reated ed B y Ezypay Online Services Pvt L td
Template Version
4.0.1
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
Nullable
Example
Method will accept authorization code which is defined at creation time
N/A
5998799662498
Not Mention
Method will accept product id
N/A
1
Type
Length
String
12
Int
Description
1
Authorization Code
2
Product
3
Mobile Number
String
14
Method will accept customer mobile no.
N/A
943658452
4
Amount
String
14
Method will accept customer recharge amount
N/A
10 0
5
Request ID
String
14
6
Request ID
String
30
Method will accept Request Id Optional from 3rd party who is calling this API Method will accept Store Id from 3rd party only for Airtel Prepaid who is calling this API
5698 5
Mendatory
NA
Response Interpretation: Sno
Response
Created B y Ezypay Online Services Pvt L td
Interpretation
Type, Clause & Resolution
Example
Page 2 of 10
1
Txnid~RequestId ~MobileNumber~Status Id~description~Amount ~ balance~ Date~oprefno
Txnid : Exypay registered ID,REquestid: Id which comes from party,Balance: current balance after last 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
12345~RE10111 ~9999999999~ 1~ Transaction Successful~ 100~500.25~12/02/2013 10:20:23~111111111
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
Nullable
Example
Method will accept authorization code which is defined at creation time
N/A
5998799662498
Not Mention Method will accept product id
N/A
1
1
Authorization Code
2
Product
3
Mobile Number
String
1 4
Method will accept customer mobile no.
N/A
943658452
4
Amount
String
1 4
Method will accept customer recharge amount
N/A
100
5
Request ID
String
1 4
Method will accept Request ID Optional from 3rd party who is calling this API
6
Circle
String
5 0
Method will accept the circle code for identifying the region
String
Int
Created B y Ezypay Online Services Pvt L td
1 2
N/A
56985
KOLKATA
Page 3 of 10
7
Account No
String
2 0
Method will accept the Account of user which is created by operator
8
Std Code
String
1
STD code of the region
N/A
44654847846545
033
Response Interpretation:
1
Response
Interpretation
Txnid~RequestId ~MobileNumber~Status Id~description~Amount ~ balance~ Date
Txnid : Exypay registered ID,REquestid: ID which comes from party,Balance: current balance after last transaction, StatusID:transaction status in Numeric , description:Transaction status description,MobileNumb er: customer mobile no, Date: Currentadtetime,Amount :Recharge Amount
Created B y Ezypay Online Services Pvt L td
Type, Clause & Resolution
Example
12345~RE10111 ~9999999999~ 1~ Transaction Successful ~100~500.25~12/02/2013 10:20:23
Page 4 of 10
4. 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 B y Ezypay Online Services Pvt L td
Page 5 of 10
VODAFONE
Top Up
12
VIDEOCON
Top Up
21
VIDEOCON
Special
22
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
AIRTEL
POSTPAID
32
AIRCEL
POSTPAID
54
BSNL
POSTPAID
31
DOCOMO
POSTPAID
52
IDEA
POSTPAID
33
MTS
POSTPAID
57
REL CDMA
POSTPAID
47
REL GSM
POSTPAID
59
LOOP MOBILE
POSTPAID
50
TATA INDICOM
POSTPAID
53
VODAFONE
POSTPAID
35
AIRTEL
LANDLINE
48
BSNL
LANDLINE
56
MTNL
LANDLINE
51
RELIANCE
LANDLINE
49
TATA INDICOM
LANDLINE
53
Product ID
Created B y Ezypay Online Services Pvt L td
Page 6 of 10
5. Response Codes Code Description 1 100 -130 -131 -136 -137 -138 -140 -141 200 -1600 -1601 -1602 -1603 -1604 -1605 -1608 -1609 -1610 -1611 -1612
Transaction Successful (Wallet Debit) Transaction Pending (Wallet Debit) Technical Failure Invalid Mobile Number Invalid Amount Operator Internal Error Invalid Account Number Operator System General Failure Invalid Input details Timeout (Wallet Debit) Invalid Product ID Operator not match Invalid Authorisation code Invalid Operator Invalid Amount Insufficient balance Internal Error Unknown Error Invalid IP address Duplicate request,please try after 10 minutes Currently operator is down,please try after sometime
Created B y Ezypay Online Services Pvt L td
Page 7 of 10
-1613 -1614 -1615 -1616 -1617
Operator is not available for this Circle Invalid Denomination Requested ID is not Unique Invalid Customer VC Number Inactive VC not allowed below 250
6. Get Balance https://api.myezypay.in/Ezypaywebservice/GetBalance.aspx?AuthorisationCode=5998799662498
This method retrieves the current balance of the Retailer
Summary:
Additional SoapHeader:
Nil
EnableSession:
No
Returns:
STRING
Parameters: Sno
Parameter
Type
Length
Description
Nullable
Example
1
AuthorisationC ode
String
12
Method will accept authorization which is defined at creation time
N/A
5998799662498
Response Interpretation: Sno
1
Response
Current Balance~Current Datetime
Created B y Ezypay Online Services Pvt L td
Interpretation
Current Balance – Agent current wallet balance
Type, Cause & Resolution
Example
500~10/02/2013 10:12 AM
Page 8 of 10
7. Transaction Enquiry https://api.myezypay.in/Ezypaywebservice/TransactionEnquiry.aspx?AuthorisationCode=5998799662498& RequestID =1264 Summary: Additional SoapHeader: EnableSession: Returns:
This method enquire details of a previous transaction Nil No STRING
Parameters:
Sno. 1
2
Parameter Authorization Code
RequestID
Type string
string
Length
Description
Nullable
Example
12
Method will accept authorization code which is defined at creation time
N/A
5998799662498
14
Method will return ReqID to 3rd party who is calling this API
N/A
56985
Response Interpretation:
Sn o
Response
Created B y Ezypay Online Services Pvt L td
Interpretation
Type, Cause & Resolution
Example
Page 9 of 10
1
Transaction Successful
Status: Status of previous txn, Description: Description of Status, RequestID: Request Id of 3rd party, ResponseID: ID of Ezypay, MobileNumber:Cu stomer mobile no.
264040 264040 9622370716 1 Transaction Successful TEST RETAILER
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 merchant’s 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 B y Ezypay Online Services Pvt L td
Page 10 of 10
