0% found this document useful (0 votes)
90 views

Smartpays Technology - API DOCUMENT

Uploaded by

vishal khade
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
90 views

Smartpays Technology - API DOCUMENT

Uploaded by

vishal khade
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 9

Smar

pay
sTechnol
ogy
Appl
i
cat
ionPr
ogr
am I
nter
faceDocument

Smartpay
stechnology
Si
nhgadRoad,Pune.
PinNo:
411051
:
Emai
linf
o@smar
tpay
s.co.
in
Mobi
l
e:9595004141

Page1
Tabl
eofCont
ent
s

I
NTRODUCTI
ON

1.
1Aboutsmar
tpay
sTechnol
ogy
1.
2Ser
vices

CONFI
DENTI
ALI
TY

TRANSACTI
ONAPI

REQUESTFORMAT

4.
1RequestPar
ameter
s
4.
2ResponseParamet
ers

STATUSCHECKAPI

SMARTPAYSTECHNOLOGYCALL-
BACKURLAPI

6.
1Int
roducti
on
6.
2Call
-BackAPIDet
ail
s

WALLETBALANCECHECKAPI

OPERATORCODE

ERRORCODE

Page2
1.I
NTRODUCTI
ON

1.
1AboutSmar
tpay
stechnol
ogy

SmartpaysTechnology,Si
nce2013asaCompanyheadquar t
eredatPune, I
ndia.
Oneoft hebestwebdev el
opment&WebDesi gnCompanyi nPune.Smar tpays
TechnologyOfferswebsit
edesigning,websit
edevelopment ,
Mobile/DTH/Postpai
dRecharge, Sear
chEngineOpt i
mizati
on,MoneyTr ansfer
,
Fl
ight
/ BusBooking,i
nter
netmar keti
ng,Soft
wareDev el
opment ,Websi
te
Promot i
on,Domain+Host i
ngser vi
cesinIndi
aatv er
yaffordabl
erates
maintaini
ngthebestquali
tyandon- ti
mecompl et
ionpoli
cy.

1.
2Ser
vices

Al
lpr
epai
dtop-
ups&post
-pai
dbi
l
lpay
ment
sforal
ltel
ecom pr
ovi
der
sacr
ossal
lci
rcl
esi
n
I
ndi
a.
Al
ldat
acar
dtop-
ups&dat
acar
dbi
l
lpay
ment
sforal
ltel
ecom pr
ovi
der
sinI
ndi
a.
Al
lDTHt op-upsforallser
viceprov
idersi
nIndia.
El
ectr
ici
ty,gas,i
nsurance,l
andli
neutil
i
tyser
vices.
Domesticmoneyt ransfer
.
AEPS.
Gi
ftCardVoucher s.
UPIServi
ce.
MovieTicketBooking
Upcomingser v
icesli
keBus, Fl
i
ghtandRailBookinget
c.

2.CONFI
DENTI
ALI
TY

Thecont entsofthisdocumentareconfi
dentialandmaycont aint
rade
secrets.Thisdocumentmaynotbedi str
ibuted&i t
scont entsmaynotbe
discl
osed, i
nwhol eorinpart
,wi
thouttheexpresswr i
tt
enconsentof
Smar tpay sTechnology.I
fthi
sdocumentbecomespubl ishedt hefol
lowi
ng
shallappl y:
Copy right©2013Smar t
paysTechnol
ogy .Al
l r
ight
sreser v
ed

Page3
3.TRANSACTI
ONAPI

Ther
ear
etwor
equestt
ypes:
PaymentAPI(Mobil
eNumberandAmountv al
i
dation,
appl
icabl
ewhere
operat
orhast
hisfeat
urei
nthei
rAPI)
Stat
usCheckAPI(Opti
onal
.Thi
sneedstobecallONLYforPENDING
tr
ansacti
on/Noresponsefr
om smart
paysServer
)

AnURI ,unif
ormr esourceidentif
ier,i
susedf oreachof3basi cr
equesttypes.
ThreeuniqueURLaddr essesar eusedf oreachSer v
iceProvi
der.I
ncaseof
SuccessfulresponseonFi rst(PaymentAPI ).IncaseofPay mentAPIbeing
successfull
yacknowl edged,thet r
ansacti
ont obet r
eatedassuccess/fail
ure/
Pendingbasedont heerrorcodes/r esul
tcodescombi nati
ondescri
bedbelow.
Noneedt ocallst
atusAPIf orSuccessANDf ail
urer
esponse.Stat
usAPIt obe
cal
ledONLYf orpendingresponsei nsecond/ paymentAPIORnor esponse
fr
om Smar t
paysSer v
er.

Pleasenote:Weshoul
ddebittheamountf
rom t
hei
rchannel
par
tnerdur
ing
SuccessfulorPendi
ngresponseinPay
mentAPI.

Fol
lowi
ngarethebasi
cinf
ormat
ionaboutt
hei
nter
faceanddat
a
communicat
ionpr
otocol
.

Program inter
actionwithsmar t
pays®pay mentser vi
cesisor ganizedov erthe
openI nt
ernetcommuni cati
onchannelsusingTCP/ I
P.Dat atransmi ssion
comesdownt otheexchangeofmessageswi thinthelimit
sofappl iedlev
el
protocolofHTTP( RFC2068,RFC2616).
POSTmet hodshouldbeusedf ortherequeststothepay mentsy stem server
.The
Content-
Ty peHTTPheadershoul dbesett o"appl
icati
on/x-www- form-url
encoded".TheCont ent
-Lengthheadershouldcontainthecorrectv al
ue.
Deal
erneedstosendAuthori
zati
onHTTPHeaderwi theveryrequest
.All
requestwi
l
lbe
SSLbased.
Therequestmessagebodyistr
ansfer
redinthesameway ,asthedata,
transf
ormedintheHTMLf or
m.
Ti
meoutt hr
eshol
dforever
yrequestaresetat30sec.Postitwil
lbeconsider
edasPendi
ng
atourend.
ForallTi
meout/Pendingtransacti
onst hedeal
er/Retai
l
erneedstocheck
tr
ansacti
onstat
us( STATUSURL)af t er15mi
nutesofti
meinter
valf
rom
actualr
equestt
imeORt heycancheckt hest
atusonthecal
lbackURL
provi
dedtoSmar t
paysfrom dealerend.
Forcertaincaseswherethestatusisst
il
lpending,t
hedealercangett
hischeckof
fl
ine
wi t
hourSuppor tTeam throughemailorphone.
Thetransactionshoul
dber econcil
edondailybasi
sfrom t
heautomatedreport
ssentt
o
desi gnat
edemai l
IDs.

Page4
5.REQUESTFORMAT

5.
1Request

5.
1.1RequestPar
amet
ers

Ter
ms Meani
ngs
AccessKey Passaccesskeyinheaderf
oraut
hor
izat
ion
operat
orcode provi
dedinli
stbel
ow
number rechar
gingno
amount Denominati
onforrechar
ge
tr
nx_id yourtr
ansacti
onrefno

5.
1.2ResponsePar
amet
ers

Ter
ms Meani
ngs
er
ror GivenERRORCODEwi t
ht hisparameter(See
8.6)
tr
nx_id Smar tpaysTr ansact i
onID
stat
us Theaccur atest atusoft ransactionasSuccess
/
Fail
ur eorPendi ng.Ther ewoul dbe
noneedt ofir
et her equestonst at
usURL’sf or
Success( ErrorFal se)andFai l
ure(Er
rorother
than
False)casesr eceiv edinpay mentAPI
responses.
Onlyf orPending( Er r
orFal se)casesyouhav e
to
calltheStatusCheckAPIURL.

oper
ator
_id Oper
atorTransact
ionI
D
message Tr
ansacti
onstatusmessage
Page5
REQUESTMETHODPOST

RequestURL:

ht
tp:
//www.
por
tal
.smar
tpay
s.co.
in/
api
_user
s/get
_tr
nx

5.
2Response:

{
"err
or":
" f
alse",
"data"
:{
'
tr
nx_ id':"
121211" ,
'
status' :
"Success/Fail
ure/
Pending",
'
oper ator_i
d':"MHR444445644460000",
'
message' :"RequestSuccessf
ul",
}
}

I
FANYERROROCCURE=

{
"err
or"
:"t
rue"
,
"data"
:{
"msg":
"ERROR:
:
Insuf
fi
cientBal
ance.
"
}
}

6.STATUSCHECKAPI

Ter
ms Meani
ngs
t
xni
d yourrefnowhichissenti
npay
mentapi
or
smartpays
tr
ansacti
on_i
d
st
aus Success/
Fail
ure
opi
d operat
orref
erenceno

St
atuscheckURL

ht
tp:
//www.
por
tal
.smar
tpay
s.co.
in/
api
_user
s/get
_st
atus

Response:

{
"err
or"
:"fal
se"
,
"data"
:{
'
tr
nx_i
d':"
121211"
,

Page6
'
recharge_i
d':"12121001",
'
status':"
Success/Fail
ure/
Pending",
'
oper at
or_i
d':"MHR444445644460000",
'
message' :"RequestSuccessf
ul",
}
}

Responsei
ftr
ansact
ionnotf
ound:

{
"err
or"
:"t
rue",
"data"
:{
"msg":
"Transact
ionNotFound"
}
}

6.WALLETBALANCECHECKAPI

RequestURL:

ht
tp:
//www.
por
tal
.smar
tpay
s.co.
in/
api
_user
s/get
_bal
ance

Response:

{
"error
":"
fal
se"
,
"data":{
"curr
ent_
bal
ance"
:"18150.
22"
}
}

7.Smar
tpay
sTECHNOLOGYCALL-
BACKURLAPI

Bel
owar
ethecal
lbackURLdet
ail
swi
thi
nputpar
amet
ersexpl
ained

Ter
ms Meani
ngs
t
xid yourrefnowhi chissenti
npay
mentapi
or
smar t
pays
tr
ansaction_i
d
st
atus Success/Fail
ure
opi
d operatorref
erenceno

Page7
Cal
lBackURL:

ht
tp:
//y
our
domai
n.com/
page?
txi
d=y
our
_ref
_no&st
atus=Success/
Fai
l
ure&opi
d=oper
ator
_ref
_no

8.
OPERATORCODE:

oper
ator code Post
pai
d
AIRTEL A PAT
I
DEA I PI
D
VODAFONE V PVF
BSNL Bforspeci
alBS PBS
JI
O JO
DOCOMO Dforspeci
alDS
VI
DECONDTH VTV
TATASKY TTV
DISHTV DTV
AIRTELTV ATV
SUNTV STV
BI
GTV BTV

9.
ERRORCODE:

SrNo Descr
ipt
ion
1. ERROR: :
Insuffici
entBal
ance
2. TransactionNotFound
3. ERROR: :
Aut henti
cati
onFail
4. ERROR: :
Conf igur
ati
on
Mission
5. ERROR: :
Mi nimum amount10
I
NRForRechar ge.
6. ERROR: :
InternalServ
erErr
or

Page8

You might also like