NICEPAY API
...
Payment - API Checkout
Convenience Store - API Checkout
16 min
about convenience store api checkout this {{api}} uses by {{the}} {{merchant}} to request {{payment}} to {{nicepay}} for {{the}} {{cvs}} {{paymethod}} using {{checkoutproduct}} {{api}} flow process cvs payment flow description of registration steps on cvs the {{customer}} does {{checkout}} the {{customer}} sends {{checkout}} data to {{the}} {{merchant}} the {{merchant}} registers {{checkout}} via {{api}} registration with {{nicepay}} {{nicepay}} validates and generates {{the}} {{payment}} number {{nicepay}} sends {{the}} number that needs to be paid to {{the}} {{merchant}} the {{merchant}} sends {{the}} number that needs to be paid to {{the}} {{customer}} the {{customer}} receives {{the}} cvs {{payment}} number the {{customer}} sends {{the}} cvs {{payment}} number to cvs cvs sends inquiry data to {{nicepay}} {{nicepay}} {{proceed}} with {{the}} inquiry request {{nicepay}} sends inquiry {{information}} to cvs the {{customer}} makes a {{payment}} the {{customer}} {{proceed}} s with a {{payment}} at cvs cvs {{proceed}} with {{the}} proof of {{payment}} cvs sends {{payment}} proof to {{the}} {{customer}} cvs sends a {{notification}} to {{nicepay}} {{nicepay}} updated {{the}} {{status}} {{nicepay}} sends {{the}} {{notification}} s to {{merchant}} s the {{merchant}} submits a {{status}} check to {{nicepay}} {{nicepay}} accepts applications {{nicepay}} sends a response to {{the}} {{merchant}} the {{merchant}} receives {{the}} final {{status}} the {{merchant}} sends {{the}} results of {{the}} {{order}} to {{the}} {{customer}} nicepay secure payment page convenience store secure payment page the image above is a {{payment}} sample with {{the}} {{cvs}} method using {{nicepay}} secure {{paymentproduct}} page cvs secure payment page after choosing {{the}} {{cvs}} method, you will provide with {{cvs}} (indomaret & alfamart) lists that can choose whether to continue {{the}} {{payment}} {{process}} success secure payment page the {{process}} of {{the}} {{payment}} registration request completes, you can continue {{the}} {{transaction}} {{process}} until settlement by following {{the}} guidelines on docid\ lvlw5n6loevredptxh0bq api checkout transaction payment api url /nicepay/redirect/v2/payment request method redirect get header content type application/form urlencoded request parameters for convenience store api checkout (callbackurl) parameter type size description remark paymenturl required required ans 14 {{paymentproduct}} url required https //dev nicepay co id/nicepay/redirect/v2/payment txid required required an 30 transaction id ionpaytest00202212231106386098 response parameters for convenience store api checkout (callbackurl) parameter type size description remark resultcd n 4 docid 7o8nl7guqp asiwfdqi3v 0000 resultmsg an 255 result message docid\ wpcemazro xvnxz 1zaib success txid an 30 transaction id ionpaytest00202212231106386098 when success referenceno ans 40 order number ordno20221223111252 when success amt n 12 transaction amount 10000 when success payno cvs cvs n 20 {{paymentproduct}} number 9041231106386098 when success mitracd an 4 docid\ tm257gq3dxgzf98uz0l33 alma when success transdt n 8 transaction date ( yyyymmdd ) 20221223 when success transtm n 6 transaction time ( hh24miss ) 110638 when success note response {{parameter}} will be sent through callbackurl with content type application/json and method post parameter sample parameter for convenience store api checkout (callbackurl) on {{the}} {{payment}} when {{checkoutproduct}} , response from {{the}} request that got hit is callback url request parameter curl curl x get "https //www merchant com/callbackurl?txid=ionpaytest00202212231106386098\&referenceno=ordno20221223111252\&amount=10000\&transdt=20221223\&transtm=110638\&payno=9041231106386098\&mitracd=alma\&resultcd=0000\&resultmsg=success" callback parameter response callback txid=ionpaytest00202212231106386098 referenceno=ordno20221223111252 amount=10000 transdt=20221223 transtm=110638 payno=9041231106386098 mitracd=alma resultcd=0000 resultmsg=success callback handling api checkout payment when callback received to your callbackurl , we strongly recommend {{merchant}} to verify {{the}} status by using docid\ tsmzvn ulka6hnmbkk5wl callback handling is necessary to minimize fraud actions we strongly recommend {{merchant}} to verify using callback parameter url callback "callbackurl" "https //www merchant com/callbackurl/" response callback txid\ cvsnormal000202212211000494698 referenceno\ ordno 20221221101233 amount 10000 transdt 20221221 transtm 100049 payno 504100002557 mitracd\ alma resultcd 0000 resultmsg\ success