NICEPAY API
...
API Convenience Store
Status Inquiry - API Convenience Store
10 min
about api convenience store status inquiry integration of {{the}} status inquiry {{api}} into {{the}} {{cvs}} is necessary so that {{merchant}} s can check {{the}} ongoing {{status}} of {{the}} {{transaction}} {{process}} carried out by {{the}} {{customer}} , whether {{the}} {{status}} is successful, failed or failed, and others so that {{the}} {{system}} can have a report on that {{information}} api convenience store status inquiry integration of inquiry status at {{cvs}} aims to enable {{merchant}} s to connect with {{the}} {{api}} {{system}} to check {{the}} {{status}} of {{cvs}} {{paymethod}} s on a regular basis api endpoint /nicepay/direct/v2/inquiry request method post post description performs inquiry request to {{nicepay}} for status checking merchant token sha256( timestamp + imid + referenceno + amt + merchantkey ) request format application/json when your dbprocessurl received a {{notification}} , we strongly encourage {{merchant}} s to verify {{the}} {{notification}} using {{the}} docid 79r7v9ynenetfidqqvmkk notification handling is very useful to minimize {{the}} risk of fraud we strongly encourage {{merchant}} s to verify notification handling through docid\ kkotypfurrmcyn8jl she request parameter for convenience store status inquiry the following is a list of {{parameter}} s for requesting a {{status}} inquiry on a {{cvs}} {{transaction}} {{process}} parameter type size description example / notes timestamp required required n 14 request timestamp ( yyyymmddhh24miss ) 20221012080918 txid required required an 30 transaction id ionpaytest00202212091011228108 imid required required an 10 {{merchant}} id ionpaytest referenceno required required ans 40 {{merchant}} order number order20221012080918 amt required required n 12 transaction amount 1 merchanttoken required required an 255 merchant token 666b397e7bce1d65e2cc553205ebab7330f9b2da8293b02c342279c1b6999ceb response parameter for convenience store status inquiry the following is a list of responses to requests for {{status}} inquiry in {{the}} {{cvs}} {{transaction}} {{process}} parameter type size description example / notes resultcd n 4 docid 2r5sr3xvppu1eju1nitg 0000 resultmsg an 255 result message docid 4 fpewlvczfhcvygxwck9 unpaid txid an 30 transaction id ionpaytest00202212091011228108 imid an 10 {{merchant}} id ionpaytest referenceno ans 40 {{merchant}} reference number order20221012080918 paymethod n 2 docid\ ek 0djw7nuhytcda4sa3p 03 amt n 12 {{paymentproduct}} amount 1 cancelamt n 12 cancel amount reqdt n 8 transaction request date ( yyyymmdd ) 20221209 reqtm n 6 transaction request time ( hh24miss ) 101122 transdt n 8 transaction date ( yyyymmdd ) transtm n 6 transaction time ( hh24miss ) depositdt n 8 transaction deposit date ( yyyymmdd ) deposittm n 6 transaction deposit time ( hh24miss ) currency a 3 currency idr goodsnm an 100 goods name test transaction {{nicepay}} billingnm a 100 buyer name john doe status n 1 docid\ allhyf9mj hw8 mpz4tmu 3 additional response parameter for others status inquiry the following is additional response list {{information}} from request {{status}} inquiry in other {{transaction}} {{process}} es parameter type size description example / notes mitracd a 4 docid 0upx1lyg1o2f4biu3ssp (cvs, {{directdebit}} , {{ewallet}} , {{payloan}} ) alma payno n 12 cvs number (cvs) 9041091011228108 payvaliddt n 8 cvs expiry date ( yyyymmdd ) (cvs) 20221216 payvalidtm n 6 cvs expiry time ( hh24miss ) (cvs) 235959 receiptcode ans 20 authorization code (cvs) mrefno an 20 {{bank}} reference number ( {{directdebit}} ) sample json for convenience store status inquiry json request { "timestamp" "20221012080918", "txid" "ionpaytest00202212091011228108", "referenceno" "order20221012080918", "imid" "ionpaytest", "amt" "1", "merchanttoken" "666b397e7bce1d65e2cc553205ebab7330f9b2da8293b02c342279c1b6999ceb" } json response { "txid" "ionpaytest00202212091011228108", "imid" "ionpaytest", "currency" "idr", "amt" "1", "instmntmon" null, "instmnttype" "1", "referenceno" "order20221012080918", "goodsnm" "test transaction nicepay", "paymethod" "03", "billingnm" "john doe", "reqdt" "20221209", "reqtm" "101122", "status" "3", "resultcd" "0000", "resultmsg" "unpaid", "cardno" null, "preauthtoken" null, "acqubankcd" null, "issubankcd" null, "vacctvaliddt" null, "vacctvalidtm" null, "vacctno" null, "bankcd" null, "payno" "9041091011228108", "mitracd" "alma", "receiptcode" null, "cancelamt" null, "transdt" "20221209", "transtm" "101122", "recurringtoken" null, "cctranstype" null, "payvaliddt" "20221216", "payvalidtm" "235959", "mrefno" null, "acqustatus" null, "cardexpyymm" null, "acqubanknm" null, "issubanknm" null, "depositdt" null, "deposittm" null, "paymentexpdt" null, "paymentexptm" null, "paymenttrxsn" null, "canceltrxsn" null, "userid" null, "shopid" null } java request //inquiry registration// nicepay settimestamp("20221208091279"); nicepay setimid("ionpaytest"); nicepay setamt("10000"); nicepay setreferenceno("ordno20221202141217"); nicepay setmerchanttoken(nicepay maketoken(nicepay getmerchanttoken()); nicepay settxid("ionpaytest08202212080918308275"); // request inquiry nicepay inquiry(); // response string // system out println("final response string " + nicepay getresponsestring()); string resultcd = nicepay get("resultcd"); string resultmsg = nicepay get("resultmsg"); string txid = nicepay get("txid"); string referenceno = nicepay get("referenceno"); string paymethod = nicepay get("paymethod"); string status = nicepay get("status") string amt = nicepay get("amt"); string transdt = nicepay get("transdt"); string transtm = nicepay get("transtm");