NICEPAY API
...
API Version 1 (V1)
V1 Enterprise
Virtual Account - V1 Enterprise
8min
virtual account {{nicepay}} offers {{va}} as {{paymethod}} this method allows {{customer}} to make {{payment}} via atm, {{sms}} {{bank}} ing, internet {{bank}} ing, or mobile {{bank}} ing real time notification will be sent when {{customer}} has completed {{the}} {{payment}} supported bank by nicepay {{bank}} mandiri {{bank}} international {{indonesia}} maybank {{bank}} permata {{bank}} permata syariah {{bank}} central asia (bca) {{bank}} negara {{indonesia}} 46 (bni) {{bank}} keb hana {{indonesia}} {{bank}} rakyat {{indonesia}} (bri) {{bank}} cimb niaga {{bank}} danamon we support {{va}} {{payment}} for other {{bank}} via atm bersama, alto, link, and prima va flow v1 {{merchant}} request va registration to {{nicepay}} {{merchant}} display va details and how to pay details {{customer}} make {{payment}} with preferred channel (m {{bank}} ing, atm, etc) {{nicepay}} send notification to {{merchant}} virtual account flow v1 enterprise transaction flow {{customer}} send {{checkout}} data to {{merchant}} {{merchant}} send request registration using regist api to {{nicepay}} {{nicepay}} send response va number and txid to {{merchant}} {{merchant}} save va number {{merchant}} send {{information}} about va to {{customer}} {{customer}} input va number then send {{the}} data to {{bank}} {{bank}} send {{information}} about inquiry to {{customer}} {{customer}} make {{payment}} using va to {{bank}} {{bank}} validate {{the}} {{payment}} {{bank}} send {{payment}} result {{information}} to {{customer}} {{bank}} send {{paymentproduct}} notification/ {{paymentproduct}} message to {{nicepay}} {{nicepay}} update {{payment}} {{status}} {{nicepay}} send dbprocessurl {{notification}} to {{merchant}} {{merchant}} receive {{notification}} {{merchant}} check inquiry status using inquiry {{api}} to {{nicepay}} {{nicepay}} send response to {{merchant}} {{merchant}} update {{status}} {{merchant}} send order confirmation to {{customer}} va registration api specifications va registration api endpoint /nicepay/api/onepass do request method application/x www form urlencoded application/x www form urlencoded post post description request vacctno for {{va}} {{paymentproduct}} merchant token sha256( imid + referenceno + amt + merchantkey ) payment method 02 {{va}} request parameter va registration sample api request // payment mandatory field nicepay setpaymethod("02"); nicepay setcurrency("idr"); nicepay setamt("1000"); nicepay setreferenceno("merchantreferencenumber001"); nicepay setbankcd("bmri"); nicepay setgoodsnm("merchant goods 1"); nicepay setbillingnm("john doe"); nicepay setbillingemail("buyer\@merchant com"); nicepay setbillingphone("08123456789"); nicepay setbillingaddr("billing address"); nicepay setbillingcity("jakarta"); nicepay setbillingstate("jakarta"); nicepay setbillingpostcd("12345"); nicepay setbillingcountry("indonesia"); nicepay setdeliverynm("john doe delivery"); 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 setvacctvaliddt("20160303"); nicepay setvacctvalidtm("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 bankvacctno= nicepay get("bankvacctno"); 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"); parameter type size description example / catatan imid required required an 10 {{merchant}} id ionpaytest paymethod required required an 2 nicepay code v1 professional docid\ pnv6uw k42cisgzemke y 02 currency required required n 3 currency idr amt required required n 12 goods amount 15000 referenceno required required ans 40 {{merchant}} order number ordno123124 goodsnm required required an 100 goods name test goods billingnm required required a a billing name john doe billingphone required required n 15 billing phone number 08123456789 billingemail required required an 40 billing e mail test\@merchant com billingaddr an 100 billing address billing address 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) {} bankcd required required a 4 nicepay code v1 professional docid\ pnv6uw k42cisgzemke y cena deliverynm a 30 delivery name john doe deliveryphone n 15 delivery phone 08125912342 deliveryaddr an 100 delivery address jln merak 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 merfixacctid an 40 {{merchant}} reserved va id 9999000000000001 only va fix account vacctvaliddt n 8 va expiry date ( yyyymmdd ) 20200303 vacctvalidtm n 6 va expiry time ( hh24miss ) 135959 response parameter va registration sample api response { "resultcd" "0000", "amount" "10000", "goodsnm" "test transaction nicepay", "referenceno" "99997", "transtm" "104721", "txid" "testidtest02201803011047210789", "description" "payment of referenceno 99997,this description", "bankvacctno" "1047210789", "resultmsg" "success", "billingnm" "thomas alfa edison", "vacctvaliddt" "20180308", "paymethod" "02", "bankcd" "bmri", "callbackurl" "http //www merchant com/callbackurl", "currency" "idr", "transdt" "20180301", "vacctvalidtm" "235959" } parameter type size description example / notes resultcd n 4 nicepay code v1 professional docid\ pnv6uw k42cisgzemke y 0000 resultmsg an 255 nicepay code v1 professional docid\ pnv6uw k42cisgzemke y success txid an 30 transaction id testidtest02201803011047210789 referenceno ans 40 {{merchant}} order number 99997 paymethod n 2 nicepay code v1 professional docid\ pnv6uw k42cisgzemke y 02 amount n 12 {{paymentproduct}} amount 10000 transdt n 8 transaction date ( yyyymmdd ) 20180301 transtm n 6 transaction time ( hh24miss ) 104721 description ans 100 transaction description {{paymentproduct}} of reference number 99997, this description callbackurl ans 100 callback url http //www merchant com/callbackurl http //www merchant com/callbackurl bankcd a 4 nicepay code v1 professional docid\ pnv6uw k42cisgzemke y bmri bankvacctno n 20 va number 1047210789 currency a 3 currency idr goodsnm an 100 goods name test transaction {{nicepay}} billingnm a 30 buyer name buyer name thomas alfa edison vacctvaliddt n 8 va expired date ( yyyymmdd ) 20180308 vacctvalidtm n 6 va expired time ( hh24miss ) 235959