NICEPAY API
...
Advance API
Virtual Account - Advance API
Virtual Account Static
34 min
about api virtual account static (fix open) in {{the}} static {{va}} {{paymethod}} (fix open), {{the}} {{customer}} can use {{the}} same {{va}} number continuously for multiple {{payment}} s static va {{integration}} uses for {{the}} va fix open {{paymethod}} to find out more about {{va}} {{payment}} {{information}} , you can read on virtual account (va) docid\ zf1ak3ppg5z1my1oevy7a for {{va}} {{paymethod}} settings in general, you can visit api virtual account docid\ gigve39ek5m 1rlknvnpz or learn a general explanation of va payment guide docid\ ie9rxfmm gpysjakmrbvl merchant registration credential description imid {{merchant}} id encodekey {{merchant}} api key to support setup needs, please {{download}} {{the}} following file from {{the}} {{nicepay}} library nicepay api registration nicepay api registration aims to enable {{merchant}} s to register {{the}} {{api}} {{system}} for {{payment}} in {{the}} {{merchant}} {{system}} and integrate it with {{the}} {{system}} from {{nicepay}} this step is done first so {{the}} {{system}} knows that {{the}} related {{merchant}} has been officially registered and can be connected to {{service}} s from {{nicepay}} api url https //www nicepay co id/nicepay/api/vacctcustomerregist do request method post post merchant token sha256( imid + customerid + merchantkey ) request format application/x www form urlencoded application/x www form urlencoded request parameter for registration va static the following is a list of {{parameter}} s for submitting {{the}} registration for a static type (fix open) {{va}} {{paymethod}} this {{parameter}} is used through {{the}} {{api}} {{testing}} platform as one of {{the}} stages so that {{the}} {{merchant}} 's {{system}} can connect to {{service}} s from {{nicepay}} parameter tipe size description example / notes imid required required an 10 {{merchant}} id fixopen001 customerid required required n max 8 (depend on {{merchant}} prefix) {{merchant}} {{customer}} id 10021198 customernm required required an 20 30 {{customer}} name jack merchanttoken required required an 255 {{merchant}} token c31fec3c0e66c9d8703f9f8221f7c450950d7d26822abe037ce33c12f462c785 response parameter for registration va static the following are {{the}} response {{parameter}} s from {{the}} results of {{the}} request {{parameter}} to register {{the}} virtual account statistics payment method parameter type size description example / notes resultcd required required n 4 result code result code docid 2r5sr3xvppu1eju1nitg 0000 resultmsg required required an 255 result message error code docid 4 fpewlvczfhcvygxwck9 success customerid required required n max 8 (depend on {{merchant}} prefix) {{merchant}} {{customer}} id 10021198 customernm an 20 30 {{merchant}} {{customer}} name jack vacctinfolist required required array of object {{bank}} {{va}} list \[ { "bankcd" "bdin", "vacctno" "7917019110021198" }, ] sample json registration virtual account static form urlencoded request imid "fixopen001" customerid "10021198" customernm "jack" merchanttoken "c31fec3c0e66c9d8703f9f8221f7c450950d7d26822abe037ce33c12f462c785" json response { "resultcd" "0000", "resultmsg" "success", "customerid" "10021198", "customernm" "jack", "vacctinfolist" \[ { "bankcd" "bdin", "vacctno" "7917019110021198" }, { "bankcd" "bnia", "vacctno" "11695109010021198" }, { "bankcd" "bmri", "vacctno" "8804910910021198" }, { "bankcd" "bnin", "vacctno" "1111111310021198" }, { "bankcd" "ibbk", "vacctno" "1111112010021198" }, { "bankcd" "hnbn", "vacctno" "765430000000000010021198" }, { "bankcd" "bbba", "vacctno" "1111111910021198" }, { "bankcd" "cena", "vacctno" "7007216110021198" }, { "bankcd" "yudb", "vacctno" "9044444450010021198" } ] } java request // va registration // // va registration mandatory field nicepay setcustomerid("10021198"); nicepay setcustomername("jack"); nicepay setmerchanttoken(nicepay maketoken(nicepay getcustomerid())); // request va registration nicepay varegist(); // response string // system out println("final response string " + nicepay getresponsestring()); string resultcd = nicepay get("resultcd"); string resultmsg = nicepay get("resultmsg"); string customerid = nicepay get("customerid"); string vacctinfolist = nicepay get("vacctinfolist"); vacct info list parameter type size description example/notes bankcd required required an 4 bank code docid\ qbeq29lj53z vbvxtvb7l bdin vacctno required required n 16 {{va}} number 7917019110021198 sample json vacct account json vacct account response { "vacctinfolist" \[ { "bankcd" "bdin", "vacctno" "7917019110021198" }, { "bankcd" "bnia", "vacctno" "11695109010021198" }, { "bankcd" "bmri", "vacctno" "8804910910021198" }, { "bankcd" "bnin", "vacctno" "1111111310021198" }, { "bankcd" "ibbk", "vacctno" "1111112010021198" }, { "bankcd" "hnbn", "vacctno" "765430000000000010021198" }, { "bankcd" "bbba", "vacctno" "1111111910021198" }, { "bankcd" "cena", "vacctno" "7007216110021198" }, { "bankcd" "yudb", "vacctno" "9044444450010021198" } ] } nicepay virtual account inquiry nicepay virtual account inquiry aims to obtain {{customer}} {{information}} and also {{va}} numbers to {{proceed}} with monitoring for further development purposes the settings for {{nicepay}} {{va}} inquiry aim to collect {{information}} on a list of {{va}} s registered from any {{bank}} based on merfixid target url https //www nicepay co id/nicepay/api/vacctcustomerinquiry do method post, get post, get description to perform va checking on customerid merchant token sha256( imid + customerid + merchantkey ) request format application/x www form urlencoded application/x www form urlencoded request parameter for virtual account inquiry the following is a list of {{parameter}} s for requesting a {{va}} inquiry this {{parameter}} is used through {{the}} {{api}} {{testing}} platform as one of {{the}} steps so that {{the}} {{merchant}} 's {{system}} can connect to {{the}} {{system}} from {{nicepay}} parameter type size description example / notes imid required required an 10 {{merchant}} id fixopen001 customerid required required n max 8 (depend on {{merchant}} prefix) {{merchant}} {{customer}} id 10021198 merchanttoken required required an 255 {{merchant}} token c31fec3c0e66c9d8703f9f8221f7c450950d7d26822abe037ce33c12f462c785 response parameter for inquiry the following is {{the}} response {{parameter}} s from {{the}} results of {{the}} request {{parameter}} to register {{the}} {{va}} static {{paymethod}} parameter type size description example / notes resultcd required required n 4 result code result code docid 2r5sr3xvppu1eju1nitg 0000 resultmsg required required an 255 result message error code docid 4 fpewlvczfhcvygxwck9 success customerid required required n max 8 (depend on {{merchant}} prefix) {{merchant}} {{customer}} id 10021198 customernm required required an 20 30 {{merchant}} {{customer}} name jack vacctinfolist required required array of object {{bank}} {{va}} list \[ { "bankcd" "bdin", "vacctno" "7917019110021198" }, { "bankcd" "bnia", "vacctno" "11695109010021198" }, ] sample json nicepay virtual account inquiry form urlencode request imid "fixopen001" customerid "10021198" merchanttoken "c31fec3c0e66c9d8703f9f8221f7c450950d7d26822abe037ce33c12f462c785" json response { "resultcd" "0000", "resultmsg" "success", "customerid" "10021198", "customernm" "jack", "vacctinfolist" \[ { "bankcd" "bdin", "vacctno" "7917019110021198" }, { "bankcd" "bnia", "vacctno" "11695109010021198" }, { "bankcd" "bmri", "vacctno" "8804910910021198" }, { "bankcd" "bnin", "vacctno" "1111111310021198" }, { "bankcd" "ibbk", "vacctno" "1111112010021198" }, { "bankcd" "hnbn", "vacctno" "765430000000000010021198" }, { "bankcd" "bbba", "vacctno" "1111111910021198" }, { "bankcd" "cena", "vacctno" "7007216110021198" }, { "bankcd" "yudb", "vacctno" "9044444450010021198" } ] } java request 1 // va inquiry // 2\ // va inquiry mandatory field 3\ nicepay setcustomerid("12345"); 4\ nicepay setmerchanttoken(nicepay maketoken(nicepay getcustomerid())); 5\ 6\ // request va inquiry 7\ nicepay vainquiry(); 8\ // response string // 9\ system out println("final response string " + nicepay getresponsestring()); 10\ 11\ string resultcd = nicepay get("resultcd"); 12\ string resultmsg = nicepay get("resultmsg"); 13\ string customerid = nicepay get("customerid"); 14\ string vacctinfolist = nicepay get("vacctinfolist"); vacct info list parameter type size description example / notes bankcd required required an 4 bank code docid\ qbeq29lj53z vbvxtvb7l bdin vacctno required required n 16 {{va}} number 7917019110021198 sample json vacct account json vacct account { "vacctinfolist" \[ { "bankcd" "bdin", "vacctno" "7917019110021198" }, { "bankcd" "bnia", "vacctno" "11695109010021198" }, { "bankcd" "bmri", "vacctno" "8804910910021198" }, { "bankcd" "bnin", "vacctno" "1111111310021198" }, { "bankcd" "ibbk", "vacctno" "1111112010021198" }, { "bankcd" "hnbn", "vacctno" "765430000000000010021198" }, { "bankcd" "bbba", "vacctno" "1111111910021198" }, { "bankcd" "cena", "vacctno" "7007216110021198" }, { "bankcd" "yudb", "vacctno" "9044444450010021198" } ] } nicepay virtual account deposit nicepay virtual account deposit in {{the}} {{system}} aims to check {{the}} {{status}} of a fixed open {{va}} and to display how much amt (amount) is paid with a certain txid ( {{transaction}} id) and at a certain time target url https //www nicepay co id/nicepay/api/vacctinquiry do method post post description api check status for va fixopen merchant token sha256( imid + customerid + merchantkey ) request format application/x www form urlencoded application/x www form urlencoded request parameter for virtual account check status the following is a list of {{parameter}} s for requesting a {{va}} check deposit {{status}} this {{parameter}} uses through {{the}} {{api}} {{testing}} platform as one of {{the}} steps so that {{the}} {{merchant}} 's {{system}} can connect to {{the}} {{system}} from {{nicepay}} parameter type size description example / notes imid required required an 10 {{merchant}} id fixopen001 vacctno required required n 16 {{va}} number 8804910910021197 merchanttoken required required an 255 {{merchant}} token 20221215 startdt required required n 8 request start date ( yyyymmdd ) 20221222 enddt required required n 8 request start date ( yyyymmdd ) 75d137e8823108e47d04dadc3290cb36dc305d573323123f410c6f61acf1db63 response parameter for virtual account check status the following are {{the}} response {{parameter}} s from {{the}} request {{parameter}} result for {{the}} {{va}} check {{status}} parameter type size description example / notes resultcd required required n 4 result code docid 2r5sr3xvppu1eju1nitg success resultmsg required required an 255 result message error code docid 4 fpewlvczfhcvygxwck9 success vacctno required required n 16 {{va}} number 8804910910021197 depositinfo required required array of object {{bank}} {{va}} list \[ { "bankcd" "bmri", "date" "20221220", "time" "100733", "amt" "1600000", "txid" "fixopen00102202212201007334066", "status" "0", "referenceno" "10021197" }, ] sample json virtual account deposit form urlencode request imid "fixopen001" vacctno "8804910910021197" startdt "20221215" enddt "20221222" merchanttoken "75d137e8823108e47d04dadc3290cb36dc305d573323123f410c6f61acf1db63" json response { "resultcd" "0000", "resultmsg" "success", "vacctno" "8804910910021197", "depositinfo" \[ { "bankcd" "bmri", "date" "20221220", "time" "100733", "amt" "1600000", "txid" "fixopen00102202212201007334066", "status" "0", "referenceno" "10021197" }, { "bankcd" "bmri", "date" "20221220", "time" "101001", "amt" "160000", "txid" "fixopen00102202212201010014071", "status" "0", "referenceno" "10021197" } ] } java request // va check status deposit// nicepay setimid("fixopen001"); nicepay setvacctno("8804910910021197"); nicepay setmerchanttoken(nicepay gettoken()); nicepay setstartdt("20221215"); nicepay setenddt("20221231"); // request va check status deposit// nicepay vacheckstatusdeposit(); // response va check status deposit// system out println("response " + nicepay getresponse(); string resultcd = nicepay get("resultcd"); string resultmsg = nicepay get("resultmsg"); string vacctno = nicepay get("vacctno"); string depositinfo = nicepay get("depositinfo"); nicepay virtual account update nicepay virtual account update on {{the}} {{system}} aims to update {{the}} {{merchant}} 's {{va}} profile {{information}} {{merchant}} s can make modifications to {{the}} {{va}} to update or delete via updatetype target url https //www nicepay co id/nicepay/api/vacctcustomerupdate do method post post description merficacctnm {{api}} for {{va}} update merchant token sha256( imid + customerid + merchantkey ) request format application/x www form urlencoded application/x www form urlencoded request parameter for virtual account update the following is a list of {{parameter}} s for requesting updates from {{transaction}} s made on static type (fix open) {{va}} {{paymethod}} s this {{parameter}} uses in {{the}} {{api}} {{testing}} platform as one of {{the}} stages so that {{the}} {{merchant}} 's {{system}} can connect to {{the}} {{service}} s from {{nicepay}} parameter type size description example / notes imid required required an 10 {{merchant}} id fixopen001 customerid required required n max 8 (depend on {{merchant}} prefix) {{customer}} id 10021197 merchanttoken required required an 255 {{merchant}} token c92a4372a8417d96407becec2c3221033358c16e1c29b5ccf7fe0cec211ecbf4 customernm required required an 20 30 {{customer}} name howard updatetype required required n 2 1 create 2 update 3 delete 2 response parameter for virtual account update the following is {{the}} response {{parameter}} s from {{the}} results of {{the}} request {{parameter}} s for {{the}} {{va}} update parameter type size description example / notes resultcd required required n 4 result code docid 2r5sr3xvppu1eju1nitg 0000 resultmsg required required an 255 result message error code docid 4 fpewlvczfhcvygxwck9 success customernm required required a 20 30 {{merchant}} {{customer}} name howard customerid required required n max 8 (depend on {{merchant}} prefix) {{merchant}} {{customer}} id 10021197 vacctinfolist required required array of object {{bank}} {{va}} list \[ { "bankcd" "bdin", "vacctno" "7917019110021197" }, ] sample response va update form urlencode request imid "fixopen001" customerid "10021197" customernm "howard" merchanttoken "c92a4372a8417d96407becec2c3221033358c16e1c29b5ccf7fe0cec211ecbf4" updatetype "2" json response { "resultcd" "0000", "resultmsg" "success", "customerid" "10021197", "customernm" "howard", "vacctinfolist" \[ { "bankcd" "bdin", "vacctno" "7917019110021197" }, { "bankcd" "bnia", "vacctno" "11695109010021197" }, { "bankcd" "bmri", "vacctno" "8804910910021197" }, { "bankcd" "bnin", "vacctno" "1111111310021197" }, { "bankcd" "ibbk", "vacctno" "1111112010021197" }, { "bankcd" "hnbn", "vacctno" "765430000000000010021197" }, { "bankcd" "bbba", "vacctno" "1111111910021197" }, { "bankcd" "cena", "vacctno" "7007216110021197" }, { "bankcd" "yudb", "vacctno" "9044444450010021197" } ] } java request // va update/// nicepay setimid("fixopen001"); nicepay setcustomerid("10021197"); nicepay setmerchanttoken(nicepay gettoken()); nicepay setcustomernm("howard"); nicepay setupdatetype("2"); // request va update// nicepay vaupdate(); // response va update// system out println("response " + nicepay getresponse(); string resultcd = nicepay get("resultcd"); string resultmsg = nicepay get("resultmsg"); string customernm = nicepay get("customernm"); string customerid = nicepay get("customerid"); string vacctinfolist = nicepay get("depositinfo"); see also {{visit}} {{the}} status inquiry api checkout docid 7thqvphz6emwezw5 d4an {{page}} to find out {{api}} to check {{status}} inquiry specific for {{checkoutproduct}} {{visit}} {{the}} cancel api checkout docid\ nosop1r8knfg81vmkxsc {{page}} to find out {{api}} to cancel {{transaction}} specific for {{checkoutproduct}} {{visit}} {{the}} status inquiry api virtual account docid\ itcm3ihd d5tjo3i0zjen {{page}} to find out {{the}} {{api}} {{va}} to check {{status}} inquiry on {{api}} specific for {{paymentproduct}} {{visit}} {{the}} cancel api virtual account docid\ ijkwakzulovgqblditk d {{page}} to find out {{api}} {{va}} to cancel {{the}} {{transaction}} on {{api}} specific for {{paymentproduct}}