NICEPAY API
...
Payment - API Checkout
E-Wallet - API Checkout
20 min
about e wallet api checkout this {{api}} uses by {{merchant}} s to request a {{payment}} to {{the}} {{nicepay}} for {{the}} {{ewallet}} {{paymethod}} using {{checkoutproduct}} {{api}} process flow general general e wallet flow flow description after {{checkout}} {{the}} {{order}} the {{customer}} requests {{checkout}} to {{the}} {{merchant}} the {{merchant}} sends {{the}} {{checkout}} request using registration {{api}} to {{nicepay}} {{nicepay}} sends {{the}} response of {{order}} regist to {{the}} {{merchant}} the {{merchant}} sends {{the}} {{paymentproduct}} {{api}} to {{nicepay}} {{nicepay}} requests {{payment}} to {{the}} {{ewallet}} {{partner}} the {{ewallet}} {{partner}} generates {{the}} {{order}} {{nicepay}} stores {{the}} {{payment}} {{information}} during {{paymentproduct}} s if {{the}} {{customer}} is using ovo {{ewallet}} , then {{the}} {{ewallet}} {{partner}} will send {{notification}} to {{the}} related application to makes a {{payment}} if {{the}} {{customer}} is using another {{ewallet}} (excluding ovo and astrapay), then {{the}} {{ewallet}} {{partner}} will redirects {{customer}} to {{the}} {{partner}} 's {{payment}} {{page}} after that, {{the}} {{customer}} must login using their related {{ewallet}} account before {{proceed}} ing {{the}} {{payment}} {{process}} the {{customer}} sends {{the}} {{payment}} to {{the}} {{ewallet}} {{partner}} the {{ewallet}} {{partner}} receives {{the}} {{payment}} the {{ewallet}} {{partner}} sends a {{notification}} to {{nicepay}} {{nicepay}} receives {{the}} {{notification}} {{nicepay}} sends {{the}} {{notification}} to {{the}} {{merchant}} the {{merchant}} receives {{the}} {{notification}} the {{merchant}} requests a {{status}} check to {{nicepay}} {{nicepay}} sends {{the}} response of {{status}} checking to {{the}} {{merchant}} the {{merchant}} receives {{the}} final {{status}} the {{merchant}} sends an {{order}} confirmation to {{the}} {{customer}} astrapay astrapay e wallet flow flow description during payments if {{the}} {{customer}} doesn't have astrapay account yet the {{customer}} requests {{checkout}} to {{the}} {{merchant}} the {{merchant}} sends {{the}} registration {{api}} ( ) to {{nicepay}} {{nicepay}} sends {{the}} account link request to astrapay astrapay receives {{the}} request sent by {{nicepay}} astrapay sends {{the}} response of redirect url to {{the}} {{partner}} 's {{page}} to {{nicepay}} {{nicepay}} sends {{the}} response of {{the}} {{partner}} 's redirect url to {{the}} {{merchant}} the {{merchant}} displays registration {{page}} to {{the}} {{customer}} the {{customer}} {{proceed}} s with {{the}} account registration the {{customer}} sends {{the}} account registration to astrapay astrapay validates {{the}} account astrapay sends a {{notification}} to {{nicepay}} {{nicepay}} sends a {{notification}} to {{the}} {{merchant}} the {{merchant}} sends a {{notification}} that {{the}} account already registered to {{the}} {{customer}} the {{customer}} requests {{checkout}} to {{the}} {{merchant}} the {{merchant}} requests ( ) {{transaction}} to {{nicepay}} {{nicepay}} requests {{the}} {{transaction}} to astrapay astrapay generates {{the}} {{transaction}} astrapay sends {{the}} response of redirect url to {{nicepay}} {{nicepay}} sends {{the}} response of {{payment}} {{page}} redirect url to {{merchant}} the {{merchant}} redirects {{the}} {{customer}} to astrapay's {{payment}} {{page}} the {{customer}} verifies {{the}} {{payment}} the {{customer}} makes {{payment}} to astrapay astrapay performs {{payment}} verification astrapay sends a callback to {{nicepay}} {{nicepay}} sends {{the}} response to {{the}} {{merchant}} {{merchant}} displays {{the}} response of callback to {{the}} {{customer}} astrapay sends a {{notification}} to {{nicepay}} {{nicepay}} receives {{the}} {{notification}} {{nicepay}} sends {{notification}} to {{the}} {{merchant}} the {{merchant}} receives {{the}} {{notification}} the {{merchant}} requests a {{payment}} {{status}} check to {{nicepay}} {{nicepay}} sends {{the}} response to {{the}} {{merchant}} the {{merchant}} receives {{the}} final {{status}} the {{merchant}} updates {{transaction}} {{status}} to {{the}} {{customer}} differences in checkout process flow (redirect) the {{checkout}} {{process}} has two different flows, namely asynchronous and synchronous in {{the}} asynchronous {{process}} flow, {{customer}} s need input credentials to enter {{the}} {{partner}} 's application before making {{payment}} s meanwhile, for a synchronous {{process}} , {{customer}} s don't need to input {{the}} application's credentials first and can immediately make {{payment}} s via {{payment}} {{notification}} s sent to {{the}} {{customer}} 's application the difference in these flows can be seen from {{the}} two {{ewallet}} {{process}} flows below asynchronous process flow asynchronous on the e wallet process flow flow description after checkout of the order the {{customer}} requests {{checkout}} to {{the}} {{merchant}} the {{merchant}} sends a {{checkout}} request by using registration {{api}} to {{nicepay}} {{nicepay}} sends {{the}} response of registration {{api}} to {{the}} {{merchant}} the {{merchant}} requests {{paymentproduct}} {{api}} to {{nicepay}} {{nicepay}} requests {{payment}} to {{the}} {{ewallet}} {{partner}} the {{ewallet}} {{partner}} generates {{the}} {{order}} {{nicepay}} stores {{the}} {{payment}} {{information}} if {{the}} {{customer}} uses another {{ewallet}} (excluding ovo and astrapay), then {{the}} {{ewallet}} {{partner}} will redirect {{the}} {{customer}} to {{the}} {{partner}} 's {{payment}} {{page}} the {{customer}} login to {{the}} related {{ewallet}} account before making {{payment}} the {{customer}} sends {{the}} {{payment}} to {{the}} {{ewallet}} {{partner}} the {{ewallet}} {{partner}} receives {{the}} {{payment}} the {{ewallet}} {{partner}} sends a {{notification}} to {{nicepay}} {{nicepay}} receives {{the}} {{notification}} {{nicepay}} sends a {{notification}} to {{the}} {{merchant}} the {{merchant}} receives {{the}} {{notification}} the {{merchant}} requests {{status}} checking to {{nicepay}} {{nicepay}} sends a response of {{status}} checking to {{the}} {{merchant}} the {{merchant}} receives {{the}} final {{status}} the {{merchant}} sends an {{order}} confirmation to {{the}} {{customer}} synchronous process flow synchronous on the e wallet process flow flow description after checkout of the order the {{customer}} requests {{checkout}} to {{the}} {{merchant}} the {{merchant}} sends a {{checkout}} using registration {{api}} to {{nicepay}} {{nicepay}} sends a response of {{order}} regist to {{the}} {{merchant}} the {{merchant}} sends {{paymentproduct}} {{api}} to {{nicepay}} {{nicepay}} requests {{payment}} to {{the}} {{ewallet}} {{partner}} the {{ewallet}} {{partner}} generates {{the}} {{order}} {{nicepay}} stores {{the}} {{payment}} {{information}} the {{ewallet}} {{partner}} (ovo) will send a {{notification}} to {{the}} related application to make {{payment}} s the {{customer}} sends {{payment}} to {{the}} {{ewallet}} {{partner}} the {{ewallet}} {{partner}} receives {{payment}} the {{ewallet}} {{partner}} sends a {{notification}} to {{nicepay}} {{nicepay}} receives {{the}} {{notification}} {{nicepay}} sends {{notification}} s to {{the}} {{merchant}} the {{merchant}} receives {{the}} {{notification}} the {{merchant}} requests {{status}} checking to {{nicepay}} {{nicepay}} sends a response from {{status}} checking to {{the}} {{merchant}} the {{merchant}} receives {{the}} final {{status}} the {{merchant}} sends an {{order}} confirmation to {{the}} {{customer}} nicepay secure payment page e wallet secure payment page the image above is a {{checkoutproduct}} {{payment}} sample with an {{ewallet}} method using {{nicepay}} secure {{paymentproduct}} page e wallet secure payment page after {{the}} {{process}} of {{the}} {{payment}} registration request completes, you can continue {{the}} {{transaction}} {{process}} until settlement by following {{the}} guidelines in {{the}} docid\ ghv pfy7cev6hbcqrr t note for shopeepay and ovo {{ewallet}} , to provide a better user experience to {{the}} {{customer}} , please give a warning message for {{the}} {{customer}} to open via mobile devices success secure payment page api checkout transaction payment api url /nicepay/redirect/v2/payment request method redirect get header content type application/form urlencoded request parameter for e wallet api checkout (callbackurl) parameter type size description remark paymenturl required required ans 14 {{paymentproduct}} url https //dev nicepay co id/nicepay/redirect/v2/payment txid required required an 30 transaction id tniceew05100202212201020014087 note for shopeepay and ovo {{ewallet}} , to better user experience to {{the}} {{customer}} , please request give a warning message for {{the}} {{customer}} to open by mobile devices response parameter for e wallet 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 ionpaytest00202212201351474222 when success referenceno ans 40 order number ordno20221220131215 when success paymethod e wallet, payloan e wallet, payloan n 2 docid\ iifmsruuw7j9vmwefjz97 05 when success amt n 12 transaction amount 5000 when success transdt only cc (additional) only cc (additional) n 8 transaction date ( yyyymmdd ) 20221220 when success transtm cc cc n 6 transaction time ( hh24miss ) 135201 when success mitracd direct debit, e wallet, payloan direct debit, e wallet, payloan a 4 docid\ tm257gq3dxgzf98uz0l33 dana when success callbackurl ans 255 {{paymentproduct}} result url https //webhook site/7bef799f ebe2 4328 a7b3 6d53deedca27 when success note response {{parameter}} will be sent through callbackurl with content type application/json and method post parameter sample parameter for e wallet api checkout (callbackurl) on {{the}} {{payment}} in {{checkoutproduct}} , {{the}} response from {{the}} request that gets hit is {{the}} callback url request parameter curl curl x get "https //www merchant com/callbackurl?resultcd=0000\&resultmsg=success\&txid=ionpaytest00202212201351474222\&referenceno=ordno20221220131215\&paymethod=05\&amt=5000\&transdt=20221220\&transtm=135201\&mitracd=dana\&callbackurl=https%3a%2f%2fwebhook site%2f7bef799f ebe2 4328 a7b3 6d53deedca27" callback parameter response callback resultcd=0000 resultmsg=success txid=ionpaytest00202212201351474222 referenceno=ordno20221220131215 paymethod=05 amt=5000 transdt=20221220 transtm=135201 mitracd=dana callbackurl=https //webhook site/7bef799f ebe2 4328 a7b3 6d53deedca27 callback handling api checkout transaction payment when your callback already received callbackurl , we recommended {{the}} {{merchant}} to do {{the}} {{status}} verification using {{the}} docid 7thqvphz6emwezw5 d4an callback handling is very important to minimize {{the}} fraud act, we highly recommend {{the}} {{merchant}} to do {{the}} verification using callback parameter url callback https //www merchant com/callbackurl?resultcd=0000\&resultmsg=success\&txid=ionpaytest00202212201351474222\&referenceno=ordno20221220131215\&paymethod=05\&amt=5000\&transdt=20221220\&transtm=135201\&mitracd=dana\&callbackurl=https%3a%2f%2fwebhook site%2f7bef799f ebe2 4328 a7b3 6d53deedca27 response callback resultcd=0000 resultmsg=success txid=ionpaytest00202212201351474222 referenceno=ordno20221220131215 paymethod=05 amt=5000 transdt=20221220 transtm=135201 mitracd=dana callbackurl=https //webhook site/7bef799f ebe2 4328 a7b3 6d53deedca27