NICEPAY API
...
Payment API
API Credit Card
Status Inquiry - API Credit Card
10min
about api credit card status inquiry integration with {{the}} status inquiry {{api}} on {{cc}} s is required so that {{merchant}} s can check {{the}} {{status}} of ongoing {{transaction}} {{process}} es, whether they are successful, failed, and other {{status}} api credit card status inquiry the {{integration}} of {{status}} inquiries on {{cc}} s aims to enable {{merchant}} s to connect with {{the}} {{api}} {{system}} which has function to checking {{the}} {{status}} of {{cc}} {{paymethod}} s 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}} , {{nicepay}} strongly recommend {{merchant}} to verify {{the}} {{notification}} using {{the}} status inquiry api credit card docid\ fc bkdwkevwf2h9usoc8k notification handling is very useful to minimize the risk of fraud we strongly encourage {{merchant}} s to verify notification handling you can read more detailed {{information}} about notification handling on notification api credit card docid\ ztzv8p3ig3nv3lh5bfloi {{page}} request parameter for credit card status inquiry the following is a list of request {{parameter}} s to {{proceed}} {{the}} {{status}} inquiry request on {{cc}} {{transaction}} {{process}} parameter type size description example / notes timestamp required required n 14 request timestamp ( yyyymmddhh24miss ) 20221214091282 txid required required an 30 transaction id ionpaytest01202212140949101366 imid required required an 10 {{merchant}} id ionpaytest referenceno required required ans 40 {{merchant}} order number ordno20221214091293 amt required required n 12 transaction amount 5000 merchanttoken required required an 255 {{merchant}} token 7eceb5801db4e039223698c4eb9 response parameter for credit card status inquiry the following is a list of response parameter or {{the}} result from {{the}} request parameter for status inquiry {{cc}} parameter type size description example / notes resultcd n 4 result code docid 2r5sr3xvppu1eju1nitg 0000 resultmsg an 255 result message error code docid 4 fpewlvczfhcvygxwck9 p aid txid an 30 transaction id ionpaytest01202212140949101366 imid an 10 {{merchant}} id ionpaytest currency a 3 currency idr instmntmon n 2 installment month 1 instmnttype n 2 installment type code docid\ wfsinjxqc2s9yubbybpep 1 referenceno ans 40 {{merchant}} reference number ordno20221214091293 paymethod n 2 payment method code docid\ ek 0djw7nuhytcda4sa3p 01 amt n 12 {{paymentproduct}} amount 5000 cancelamt n 12 cancel amount null reqdt n 8 transaction request date ( yyyymmdd ) 20221214 reqtm n 6 transaction request time ( hh24miss ) 094910 status n 1 transaction status 0 transdt n 8 transaction date ( yyyymmdd ) 20221214 transtm n 6 transaction time ( hh24miss ) 094910 depositdt n 8 transaction deposit date ( yyyymmdd ) null deposittm n 6 transaction deposit time ( hh24miss ) null currency a 3 currency idr goodsnm an 100 goods name goods billingnm a 100 buyer name john doe status n 1 payment status code docid\ allhyf9mj hw8 mpz4tmu 0 additional response parameter for credit card status inquiry here is a list of additional response {{parameter}} for {{the}} result from {{the}} request {{status}} inquiry for {{cc}} {{process}} parameter type size description example / notes authno n 10 auth number 101366 issubankcd a 4 bank code docid\ qbeq29lj53z vbvxtvb7l othr acqubankcd a 4 bank code docid\ qbeq29lj53z vbvxtvb7l bmri acqubanknm a 255 acquiring {{bank}} name mandiri vacctvaliddt n 8 va expiry date ( yyyymmdd ) null vacctvalidtm n 6 va expiry time ( hh24miss ) null vacctno n 20 {{va}} number null bankcd a 4 bank code docid\ qbeq29lj53z vbvxtvb7l null payno n 12 cvs {{paymentproduct}} number null mitracd a 4 mitra code docid 0upx1lyg1o2f4biu3ssp null receiptcode ans 20 authorization number null cancelamt n 12 cancel amount null payvaliddt n 8 cvs expiry date ( yyyymmdd ) null payvalidtm n 6 cvs expiry time ( hh24miss ) null mrefno an 20 {{bank}} reference number null issubanknm a 255 issuing {{bank}} name other paymentexpdt n 6 {{paymentproduct}} expiry date ( yyyymmdd ) null paymentexptm n 6 {{paymentproduct}} expiry time ( hh24miss ) null paymenttrxsn an 32 {{paymentproduct}} transaction number null userid an 128 {{qris}} user id hash null shopid an 32 shop id null cardno ans 20 masked card number 453211 1111 cardexpyymm n 4 card expiration ( yymm ) 2712 instmntmon n 2 installment month 1 instmnttype n 2 installment type code docid\ wfsinjxqc2s9yubbybpep 1 preauthtoken an 255 pre auth token (needed for capture {{paymentproduct}} ) null recurringtoken an 255 recurring token (needed for recurring {{paymentproduct}} ) null cctranstype n 2 payment status code docid 7pas vd5ylg4vdurmygwo 1 acqustatus n 2 purchase status 1 normal 2 recurring 3 pre auth 4 capture 10 acquirerdata array 20 a dynamic array consisting of a unique reference number rrn that is provided by {{the}} {{bank}} {{partner}} when a refund is {{process}} ed this reference number can be used by {{the}} {{customer}} to track {{the}} {{status}} of {{the}} refund with {{the}} {{bank}} "acquirerdata" { "rrn" "332608321717" } sample json for credit card status inquiry json request { 	"timestamp" "20221214091282", 	"txid" "ionpaytest01202212140949101366", 	"imid" "ionpaytest", "merchanttoken" "7eceb5801db4e039223698c4eb9871432217132d8b0483122001a2569e8c7537", 	"referenceno" "ordno20221214091293", 	"amt" "5000" } json response { "txid" "ionpaytest01202212140949101366", "imid" "ionpaytest", "currency" "idr", "amt" "5000", "instmntmon" "1", "instmnttype" "1", "referenceno" "ordno20221214091293", "goodsnm" "goods", "paymethod" "01", "billingnm" "john doe", "reqdt" "20221214", "reqtm" "094910", "status" "0", "resultcd" "0000", "resultmsg" "paid", "cardno" "453211 1111", "preauthtoken" null, "acqubankcd" "bmri", "issubankcd" "othr", "vacctvaliddt" null, "vacctvalidtm" null, "vacctno" null, "bankcd" null, "payno" null, "mitracd" null, "receiptcode" null, "cancelamt" null, "transdt" "20221214", "transtm" "094910", "recurringtoken" null, "cctranstype" "1", "payvaliddt" null, "payvalidtm" null, "mrefno" null, "acqustatus" "10", "cardexpyymm" "2712", "acqubanknm" "mandiri", "issubanknm" "other", "depositdt" null, "deposittm" null, "paymentexpdt" null, "paymentexptm" null, "paymenttrxsn" null, "canceltrxsn" null, "userid" null, "shopid" null, "authno" "101366", "acquirerdata" { "rrn" "332608321717" } } java request //credit card inquiry// nicepay settimestamp("20221202141217"); nicepay settxid("ionpaytest01202212021455054652"); nicepay setimid("ionpaytest"); nicepay setreferenceno("ordno20221202141217"); nicepay setmerchanttoken(nicepay maketoken(nicepay getmerchanttoken()); nicepay setamt("5000"); //request credit card inquiry nicepay ccinquiry(); // response string // system out println("final response string " + nicepay getresponsestring()); string status = nicepay get("status"); string resultcd = nicepay get("resultcd"); string resultmsg = nicepay get("resultmsg"); string txid = nicepay get("txid"); string imid = nicepay get("ionpaytest"); string referenceno = nicepay get("referenceno"); string paymethod = nicepay get("paymethod"); string currency = nicepay get("currency"); string instmntmon = nicepay get("instmntmon"); string instmnttype = nicepay get("instmnttype"); string goodsnm = nicepay get("goodsnm"); string billingnm = nicepay get("billingnm"); string reqdt = nicepay get("reqdt"); string reqtm = nicepay get("reqtm"); string acqubankcd = nicepay get("acqubankcd"); string issubankcd = nicepay get("issubankcd"); string acqubanknm = nicepay get("acqubanknm") string issubanknm = nicepay get("issubanknm"); string transdt = nicepay get("transdt"); string transtm = nicepay get("transtm"); string cctranstype = nicepay get("cctranstype"); string acqustatus = nicepay get("acqustatus"); string cardno = nicepay get("cardno"); string cardexpyymm = nicepay get("cardexpyymm"); string authno = nicepay get("authno");