NICEPAY API
...
API Version 1 (V1)
V1 Enterprise
Convenience Store (CVS) - V1 Enterprise
8min
convenience store {{nicepay}} offers {{cvs}} (cvs) as {{paymethod}} this method allows {{customer}} to make {{payment}} at their nearest {{cvs}} s, such as alfamart and indomaret real time notification will be sent when {{customer}} has completed {{the}} {{payment}} supported cvs by nicepay alfamart indomaret lawson alfamidi dan+dan store cvs flow v1 cvs flow the {{customer}} does {{checkout}} the {{customer}} sends {{the}} data to {{merchant}} {{merchant}} registers using {{api}} regist to {{nicepay}} {{nicepay}} validates and generates {{paymentproduct}} number {{nicepay}} sends {{paymentproduct}} number to {{merchant}} {{merchant}} sends {{paymentproduct}} number to {{customer}} the {{customer}} gives cvs {{payment}} number to cvs the {{customer}} sends data cvs number to cvs cvs sends inquiry data to {{nicepay}} {{nicepay}} processes inquiry {{nicepay}} sends {{information}} about inquiry to cvs the {{customer}} completes {{the}} {{payment}} the {{customer}} sends {{payment}} processing to cvs cvs makes {{payment}} evidence cvs sends {{payment}} evidence to {{customer}} cvs sends {{payment}} {{notification}} to {{nicepay}} {{nicepay}} updates {{the}} {{status}} {{nicepay}} sends {{notification}} to {{merchant}} {{merchant}} requests {{status}} check using {{api}} to {{nicepay}} {{nicepay}} receives request {{nicepay}} sends response to {{merchant}} {{merchant}} receives final {{status}} {{merchant}} sends {{order}} result to {{customer}} cvs registration api specifications cvs registration api endpoint /nicepay/api/onepass do request method application/x www form urlencoded application/x www form urlencoded post post description request payno to perform cvs {{payment}} on {{mitra}} merchant token sha256( imid + referenceno + amt + merchantkey ) payment method 03 {{cvs}} request parameter cvs registration convenience store registrasi request parameter // payment mandatory field nicepay setpaymethod("03"); nicepay setcurrency("idr"); nicepay setamt("1000"); nicepay setreferenceno("merchantreferencenumber001"); nicepay setmitracd("alma"); nicepay setgoodsnm("merchant goods 1"); nicepay setbillingnm("john doe"); nicepay setbillingemail("buyer\@merchant com"); nicepay setbillingphone("081234567890"); nicepay setbillingaddr("billing address"); nicepay setbillingcity("jakarta"); nicepay setbillingstate("jakarta"); nicepay setbillingpostcd("12345"); nicepay setbillingcountry("indonesia"); nicepay setdeliverynm("john doe"); nicepay setdeliveryphone("081234567890"); nicepay setdeliveryaddr("billing address "); nicepay setdeliverycity("jakarta "); nicepay setdeliverystate("jakarta "); nicepay setdeliverypostcd("12345"); nicepay setdeliverycountry("indonesia "); nicepay setcallbackurl(merchantdomain + "callback"); nicepay setdbprocessurl(merchantdomain + "dbprocess"); nicepay setvat("0"); nicepay setfee("0"); nicepay setnotaxamt("0"); nicepay setdescription("description"); nicepay setuserip("127 0 0 1"); nicepay setmerchanttoken(nicepay maketoken(nicepay getamt(), nicepay getreferenceno())); nicepay setcartdata("{}"); // payment optional field nicepay setreqdt("20160301"); nicepay setreqtm("135959"); nicepay setreqdomain("merchant com"); nicepay setreqserverip("127 0 0 1"); nicepay setreqclientver("1 0"); nicepay setusersessionid("usersessionid"); nicepay setuseragent("mozilla"); nicepay setuserlanguage("en us"); nicepay setmerfixacctid("9999000000000001"); nicepay setpaymentexpirydt("20160303"); nicepay setpaymentexpirytm("135959"); nicepay setpayvaliddt("20160303"); nicepay setpayvalidtm("135959"); // payment request nicepay payment(); // payment response system out println("response string " + nicepay getresponsestring()); // json in string format string resultcd = nicepay get("resultcd"); string resultmsg = nicepay get("resultmsg"); string txid= nicepay get("txid "); string referenceno= nicepay get("referenceno"); string payno= nicepay get("payno"); string paymethod= nicepay get("paymethod"); string amount= nicepay get("amount"); string transdt = nicepay get("transdt "); string transtm = nicepay get("transtm "); string description= nicepay get("description"); string callbackurl= nicepay get("callbackurl"); string mitracd= nicepay get("mitracd"); 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 03 currency required required a 3 currency idr amt required required n 12 goods amount 1000 referenceno required required ans 40 {{merchant}} order number merchantreferencenumber001 goodsnm required required an 100 goods name {{merchant}} goods 1 billingnm required required a a billing name john doe billingphone required required n 15 billing phone number 081234567890 billingemail required required ans 40 billing e mail buyer\@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 12345 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 alma 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 test\@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 user language en us payvaliddt n 8 cvs expired date ( yyyymmdd ) 20160303 payvalidtm n 6 cvs expired time ( hh24miss ) 135959 response parameter cvs registration { "resultcd" "0000", "amount" "10000", "goodsnm" "test transaction nicepay", "referenceno" "99997", "transtm" "110847", "mitracd" "alma", "txid" "testidtest03201803011108471311", "description" "payment of referenceno 99997,this description", "resultmsg" "success", "billingnm" "thomas alfa edison", "payno" "011108471311", "payvalidtm" "235959", "paymethod" "03", "callbackurl" "http //www merchant com/callbackurl", "payvaliddt" "20180308", "currency" "idr", "transdt" "20180301" } parameter type size description example / notes resultcd n 4 v1 nicepay code docid logd 07e0vrfugu0nldf 0000 resultmsg an 255 v1 nicepay code docid logd 07e0vrfugu0nldf 10000 goodsnm an 100 goods name test transaction {{nicepay}} txid an 30 transaction id testidtest03201803011108471311 referenceno ans 40 {{merchant}} order number 99997 paymethod n 2 v1 nicepay code docid logd 07e0vrfugu0nldf 03 amount n 12 {{paymentproduct}} amount 10000 transdt n 8 transaction date ( yyyymmdd ) 20180301 transtm n 6 transaction time ( hh24miss ) 110847 mitracd a 4 v1 nicepay code docid logd 07e0vrfugu0nldf alma payno n 12 cvs {{paymentproduct}} number 011108471311