NICEPAY API
...
API Versi 1
V1 Enterprise
E-Wallet - V1 Enterprise
9 min
tentang e wallet {{nicepay}} menawarkan {{ewallet}} sebagai {{metodebayar}} {{yang}} akan memudahkan {{transaksi}} dengan {{pembayaran}} menggunakan ovo, linkaja, dana, dan shopeepay ( jump app ) notifikasi real time akan dikirimkan setelah {{pelanggan}} menyelesaikan {{pembayaran}} nicepay e wallet mitra ovo linkaja dana shopeepay e wallet flow v1 {{merchant}} melakukan registrasi transaksi {{ewallet}} registration {{nicepay}} akan mengalihkan pembeli ke {{halaman}} / app {{mitra}} {{ewallet}} atau notifikasi di aplikasi {{mitra}} {{customer}} melakukan {{pembayaran}} di {{halaman}} / app {{mitra}} {{nicepay}} mengirimkan notifikasi ke {{merchant}} {{merchant}} handle notification transaction flow deskripsi langkah {{pelanggan}} mengajukan checkout kepada {{merchant}} {{merchant}} mendaftarkan checkout melalui registration {{api}} ( /nicepay/api/ewallettrans do ) kepada {{nicepay}} {{nicepay}} mengajukan {{pembayaran}} kepada {{mitra}} {{ewallet}} {{mitra}} {{ewallet}} melakukan generate pesanan {{nicepay}} menyimpan {{informasi}} {{pembayaran}} {{mitra}} {{ewallet}} mengalihkan {{pelanggan}} ke {{halaman}} milik {{mitra}} {{pelanggan}} masuk ke dalam akun {{pelanggan}} melakukan {{pembayaran}} kepada {{mitra}} {{ewallet}} {{mitra}} {{ewallet}} menerima {{pembayaran}} {{mitra}} {{ewallet}} mengirimkan {{notifikasi}} kepada {{nicepay}} {{nicepay}} menerima {{notifikasi}} {{nicepay}} mengirimkan {{notifikasi}} kepada {{merchant}} {{merchant}} menerima {{notifikasi}} {{merchant}} mengajukan pemeriksaan {{status}} kepada {{nicepay}} {{nicepay}} mengirimkan response pemeriksaan {{status}} kepada {{merchant}} {{merchant}} menerima {{status}} akhir {{merchant}} mengirimkan konfirmasi pesanan kepada {{pelanggan}} e wallet registration api specifications e wallet registration api endpoint /nicepay/api/ewallettrans do request method application/x www form urlencoded application/x www form urlencoded post post description request transaksi {{ewallet}} merchant token sha256( imid + referenceno + amt + merchantkey ) payment method 05 {{ewallet}} request parameter e wallet registration form urlencode request imid=ionpaytest\&paymethod=05\¤cy=idr\&amt=5000\&referenceno=ordno 20240627130699\&goodsnm=jhon%20doe%20s\&billingnm=jhon%20doe\&billingphone=085695655726 \&billingemail=test\@email com\&callbackurl=https //webhook site/e1e151bc 23f5 4db9 8272 6addeea95701\&dbprocessurl=https //webhook site/e1e151bc 23f5 4db9 8272 6addeea95701\&description=this%20is%20testing transaction\&merchanttoken=c9a9a1d5910757c4eef8de68d665819adcf3e066fd961b306d2ccb53ba9edb9c\&mitracd=eshp\&userip= 1\&billingcity=nicepay%20city\&billingaddr=nicepay%20company\&billingcountry=jakarta\&billingstate=nicepay%20state\&billingpostcd=12345\&cartdata={\\"count\\" \\"1\\",\\"item\\" \[{\\"img url\\" \\"https //d3nevzfk7ii3be cloudfront net/igi/vorghxlovuka566a medium\\",\\"goods name\\" \\"nokia 3360\\",\\"goods detail\\" \\"old nokia 3360\\",\\"goods amt\\" \\"5000\\",\\"goods quantity\\" \\"1\\"}]}\&returnjsonformat=1 parameter tipe ukuran deskripsi contoh / catatan imid required required an 10 merchant id ionpaytest paymethod required required n 2 v1 nicepay code docid\ pnv6uw k42cisgzemke y 05 currency required required a 3 currency idr amt required required n 12 goods amount 10000 referenceno required required ans 40 {{merchant}} reference number ordno 20240627130699 goodsnm required required an 100 goods name test transaction {{nicepay}} billingnm required required a 30 billing name john doe billingphone required required n 15 billing phone number 081234567890 billingemail required required ans 40 billing e mail email\@customer com billingcity required required a 50 billing city jakarta billingstate required required a 50 billing state dki jakarta billingpostcd required required n 10 billing post number 14350 billingcountry required required a 10 billing country {{indonesia}} callbackurl required required ans 255 {{paymentproduct}} result url https //merchant com/callbackurl dbprocessurl required required ans 255 {{paymentproduct}} notif url https //merchant com/api/dbprocessurl/notif description required required an 100 description {{paymentproduct}} of referenceno 99997 merchanttoken required required an 255 {{merchant}} token 6cfccfc0046773c1b589d8e 98f8b596c284f3c70a4ecf8 6eba14c18944b74bcd userip required required ans 15 user ip ( {{customer}} ) 127 0 0 1 cartdata required required json object 4000 cart data (json format) {} mitracd required required a 4 v1 nicepay code docid\ pnv6uw k42cisgzemke y ovoe billingaddr an 255 billing address jln cendrawasih deliverynm a 30 delivery name john doe deliveryphone n 15 delivery phone 08125912342 deliveryaddr an 100 delivery address jln merak deliveryemail ans 100 delivery e mail buyer\@merchant com	 deliverycity a 50 delivery city jakarta deliverystate a 50 delivery state dki jakarta deliverypostcd a 10 delivery post code 14350 deliverycountry a 10 delivery country {{indonesia}} vat n 12 {{vat}} 0 fee n 12 service tax 0 notaxamt n 12 tax free amount 0 reqdt n 8 request date ( yyyymmdd ) 20160301 reqtm n 6 request time ( hh24miss ) 135959 reqdomain ans 100 request domain merchant com reqserverip ans 15 request server ip 127 0 0 1 reqclientver ans 50 request client version 1 0 usersessionid an 100 user session id usersessionid useragent ans 100 user agent mozilla userlanguage ans 2 user language en us returnjsonformat optional for shopeepay to get url redirect shopeepay optional for shopeepay to get url redirect shopeepay an 100 if {{the}} value is 1 , then it will return shopeepay link if {{the}} value is empty/0 , then it will redirect to other html {{page}} 1 return redirecturlapp and/or redirecturlhttp empty/0 return html to redirect catatan untuk shopeepay agar pengalaman pengguna {{yang}} lebih baik kepada {{pelanggan}} , mohon berikan pesan peringatan ke {{pelanggan}} untuk membuka dengan perangkat seluler registration response e wallet registration sample response { "resultcd" "0000", "resultmsg" "success", "txid" "ionpaytest05202406271415477199", "referenceno" "ordno 20240627130699", "paymethod" "05", "amt" "5000", "transdt" "20240627", "transtm" "141547", "mitracd" "eshp", "paymentexpdt" "20240627", "paymentexptm" "142047", "redirecturlhttp" "https //pay uat airpay co id/h5pay/pay?type=start\&medium index=dfhkbmr1btbiamhwkgfjbkz2qaoz37tsa2hlx2cgfpmbft0o99axpjteppgvc4ir\&order key=emxd8m9exlwbdr2vj9gxreh 95ac3eu1jdongq4s cn ctswgjfwtighnwx7gmr3ttbbzl7atkxwqw\&order sn=119250619060979433\&return url=ahr0chm6ly9kzxyubmljzxbhes5jby5pzc9uawnlcgf5l2fwas9zag9wzwvqyxldywxsymfjay5kbz9hbw91bnq9ntawmdawjmnsawvudf9pzd1osunfuefzjnjlzmvyzw5jzv9pzd0wntiwmjqwnji3mtqxntq3nzg1mczyzxn1bhrfy29kzt0ymdmmc2lnbmf0dxjlpxrueg9kve8xutjhmhziznldtletcjbbwdfhdgo4dzljuklvsg9cmlvpmhclm0qmdfhpzd1jt05qqvlurvnumduymdi0mdyynze0mtu0nzcxotk%3d\&source=web\&token=dfhkbmr1btbiamhwkgfjbkz2qaoz37tsa2hlx2cgfpmbft0o99axpjteppgvc4ir", "redirecturlapp" "", "redirecttoken" null } parameter tipe ukuran deskripsi contoh / catatan resultcd n 4 v1 nicepay code docid\ pnv6uw k42cisgzemke y 0000 resultmsg an 255 result m essage v1 nicepay code docid\ pnv6uw k42cisgzemke y success txid an 30 transaction id ionpaytest05202406260930529202 referenceno ans 40 {{merchant}} 's reference number 20240626093051 paymethod n 2 v1 nicepay code docid\ pnv6uw k42cisgzemke y 05 amt n 12 amount 10000 transdt n 8 transaction date ( yyyymmdd ) 20240626 transtm n 6 transaction date ( hh24miss ) 093052 mitracd an 4 v1 nicepay code docid\ pnv6uw k42cisgzemke y eshp paymentexpdt n 8 {{paymentproduct}} expiry date ( yyyymmdd ) when success {{qris}} , shopeepay paymentexptm n 6 {{paymentproduct}} expiry time ( hh24miss ) when success {{qris}} , shopeepay redirecturlhttp an 100 jump app to shopeepay https //pay uat airpay co id/h5pay/example redirecturlapp an 100 for shopeepay (eshp), this value will be empty redirecttoken an 2000 used only for linkaja