NICEPAY API
...
API Version 1 (V1)
V1 Enterprise
E-Wallet - V1 Enterprise
9 min
e wallet {{nicepay}} offer {{ewallet}} as {{paymethod}} this allows {{customer}} to make {{payment}} with ovo, linkaja, dana, and shopeepay (jump app) real time notification will be sent when {{customer}} has completed {{the}} {{payment}} supported e wallet by nicepay ovo linkaja dana shopeepay e wallet flow v1 {{merchant}} request {{ewallet}} transaction registration to {{nicepay}} {{nicepay}} will redirect {{customer}} to {{partner}} {{paymentproduct}} page/ {{ewallet}} app or send notification to {{the}} {{partner}} app {{customer}} make {{payment}} on {{mitra}} {{paymentproduct}} page/app {{nicepay}} send notification to {{merchant}} {{merchant}} handle {{notification}} transaction flow steps description the {{customer}} requests {{checkout}} to {{the}} {{merchant}} {{merchant}} regists {{checkout}} through registration {{api}} (/nicepay/api/ewallettrans do) to {{nicepay}} {{nicepay}} request {{payment}} to {{the}} {{ewallet}} {{partner}} the {{ewallet}} {{partner}} generates {{order}} {{nicepay}} saves {{the}} {{payment}} {{information}} the {{ewallet}} {{partner}} redirect {{the}} {{customer}} to {{the}} {{partner}} {{page}} the {{customer}} logins to their account the {{customer}} {{proceed}} s {{the}} {{payment}} to {{the}} {{ewallet}} {{partner}} the {{ewallet}} {{partner}} receives {{the}} {{payment}} the {{ewallet}} {{partner}} sends {{the}} {{notification}} to {{nicepay}} {{nicepay}} receives {{the}} {{notification}} {{nicepay}} sends {{the}} {{notification}} to {{merchant}} {{merchant}} receives {{the}} {{notification}} {{merchant}} request {{the}} {{status}} check to {{nicepay}} {{nicepay}} sends {{the}} check {{status}} response to {{merchant}} {{merchant}} receives {{the}} final {{status}} {{merchant}} sends {{order}} confirmation to {{the}} {{customer}} e wallet registration api specifications e wallet registration api endpoint /nicepay/api/ewallettrans do request method application/x www form urlencoded application/x www form urlencoded post post description request {{ewallet}} transaction merchant token sha256( imid + referenceno + amt + merchantkey ) payment method 05 {{ewallet}} request parameter e wallet registration e wallet registrasi request parameter imid=ionpaytest\&paymethod=05\¤cy=idr\&amt=5000\&referenceno=ordno 20240627130699\&goodsnm=jhon%20doe%20s\&billingnm=jhon%20doe\&billingphone=085695655726 \&billingemail=test\@email com\&callbackurl=https //webhook site/e1e151bc 23f5 4db9 8272 6addeea95701\&dbprocessurl=https //webhook site/e1e151bc 23f5 4db9 8272 6addeea95701\&description=this%20is%20testing transaction\&merchanttoken=c9a9a1d5910757c4eef8de68d665819adcf3e066fd961b306d2ccb53ba9edb9c\&mitracd=eshp\&userip= 1\&billingcity=nicepay%20city\&billingaddr=nicepay%20company\&billingcountry=jakarta\&billingstate=nicepay%20state\&billingpostcd=12345\&cartdata={\\"count\\" \\"1\\",\\"item\\" \[{\\"img url\\" \\"https //d3nevzfk7ii3be cloudfront net/igi/vorghxlovuka566a medium\\",\\"goods name\\" \\"nokia 3360\\",\\"goods detail\\" \\"old nokia 3360\\",\\"goods amt\\" \\"5000\\",\\"goods quantity\\" \\"1\\"}]}\&returnjsonformat=1 parameter type size description example value imid required required an 10 {{merchant}} id ionpaytest paymethod required required n 2 v1 nicepay code docid logd 07e0vrfugu0nldf 05 currency required required a 3 currency idr amt required required n 12 goods amount 15000 referenceno required required ans 40 {{merchant}} reference number ordno 20240627130699 goodsnm required required an 100 goods name test goods billingnm required required a 30 billing name john doe billingphone required required n 15 billing phone number 081249195 billingemail required required ans 40 billing e mail test\@merchant com billingcity required required a 50 billing city jakarta billingstate required required a 50 billing state dki jakarta billingpostcd required required n 10 billing post number 14350 billingcountry required required a 10 billing country {{indonesia}} callbackurl required required ans 255 {{paymentproduct}} result url https //merchant com/callbackurl dbprocessurl required required ans 255 {{paymentproduct}} notif url https //merchant com/dbprocessurl description required required an 100 description test item merchanttoken required required an 255 {{merchant}} token 6cfccfc0046773c1b589d8e 98f8b596c284f3c70a4ecf8 6eba14c18944b74bcd userip required required ans 15 user ip ( {{customer}} ) 127 0 0 1 cartdata required required json object 4000 cart data (json format) {} mitracd required required a 4 v1 nicepay code docid logd 07e0vrfugu0nldf ovoe billingaddr an 255 billing address jln cendrawasih deliverynm a 30 delivery name john doe deliveryphone n 15 delivery phone 08125912342 deliveryaddr an 100 delivery address jln merak deliveryemail ans 100 delivery e mail buyer\@merchant com deliverycity a 50 delivery city jakarta deliverystate a 50 delivery state dki jakarta deliverypostcd a 10 delivery post code 14350 deliverycountry a 10 delivery country {{indonesia}} vat n 12 {{vat}} 0 fee n 12 service tax 0 notaxamt n 12 tax free amount 0 reqdt n 8 request date ( yyyymmdd ) 20160301 reqtm n 6 request time ( hh24miss ) 135959 reqdomain ans 100 request domain merchant com reqserverip ans 15 request server ip 127 0 0 1 reqclientver ans 50 request client version 1 0 usersessionid an 100 user session id usersessionid useragent ans 100 user agent mozilla userlanguage ans 2 user language en us returnjsonformat optional for shopeepay to get url redirect shopeepay optional for shopeepay to get url redirect shopeepay an 100 if {{the}} value is 1 , then it will return shopeepay link if {{the}} value is empty/0 , then it will redirect to other html {{page}} 1 return redirect url app and redirect url http or empty/0 return html to redirect note for shopeepay in {{order}} to better user experience to {{the}} {{customer}} , please give a warning message for {{the}} {{customer}} to open {{the}} mobile device registration response e wallet registration sample response { "resultcd" "0000", "resultmsg" "success", "txid" "ionpaytest05202406271415477199", "referenceno" "ordno 20240627130699", "paymethod" "05", "amt" "5000", "transdt" "20240627", "transtm" "141547", "mitracd" "eshp", "paymentexpdt" "20240627", "paymentexptm" "142047", "redirecturlhttp" "https //pay uat airpay co id/h5pay/pay?type=start\&medium index=dfhkbmr1btbiamhwkgfjbkz2qaoz37tsa2hlx2cgfpmbft0o99axpjteppgvc4ir\&order key=emxd8m9exlwbdr2vj9gxreh 95ac3eu1jdongq4s cn ctswgjfwtighnwx7gmr3ttbbzl7atkxwqw\&order sn=119250619060979433\&return url=ahr0chm6ly9kzxyubmljzxbhes5jby5pzc9uawnlcgf5l2fwas9zag9wzwvqyxldywxsymfjay5kbz9hbw91bnq9ntawmdawjmnsawvudf9pzd1osunfuefzjnjlzmvyzw5jzv9pzd0wntiwmjqwnji3mtqxntq3nzg1mczyzxn1bhrfy29kzt0ymdmmc2lnbmf0dxjlpxrueg9kve8xutjhmhziznldtletcjbbwdfhdgo4dzljuklvsg9cmlvpmhclm0qmdfhpzd1jt05qqvlurvnumduymdi0mdyynze0mtu0nzcxotk%3d\&source=web\&token=dfhkbmr1btbiamhwkgfjbkz2qaoz37tsa2hlx2cgfpmbft0o99axpjteppgvc4ir", "redirecturlapp" "", "redirecttoken" null } parameter type size description example / notes resultcd n 4 v1 nicepay code docid logd 07e0vrfugu0nldf 0000 resultmsg an 255 result m essage v1 nicepay code docid logd 07e0vrfugu0nldf success txid an 30 transaction id ionpaytest05202406260930529202 referenceno ans 40 {{merchant}} 's reference number 20240626093051 paymethod n 2 payment method code docid\ ek 0djw7nuhytcda4sa3p 05 amt n 12 amount 10000 transdt n 8 transaction date ( yyyymmdd ) 20240626 transtm n 6 transaction date ( hh24miss ) 093052 mitracd an 4 mitra code docid 0upx1lyg1o2f4biu3ssp eshp paymentexpdt n 8 {{paymentproduct}} expiry date ( yyyymmdd ) when success {{qris}} , shopeepay paymentexptm n 6 {{paymentproduct}} expiry time ( hh24miss ) when success {{qris}} , shopeepay redirecturlhttp an 100 jump app to shopeepay https //pay uat airpay co id/h5pay/example redirecturlapp an 100 for shopeepay (eshp), this value will be empty redirecttoken an 2000 used only for linkaja