E-Wallet - API Checkout
Tentang E-Wallet - API Checkout
API ini digunakan oleh Merchant untuk melakukan pengajuan pembayaran kepada NICEPAY untuk metode pembayaran E-Wallet menggunakan Checkout API.
Alur Proses
General
Deskripsi alur setelah melakukan checkout pesanan:
- Pelanggan mengajukan checkout kepada Merchant.
- Merchant mengirimkan pengajuan checkout menggunakan API Registration kepada NICEPAY.
- NICEPAY mengirimkan response order regist kepada Merchant.
- Merchant mengirimkan API Payment kepada NICEPAY.
- NICEPAY mengajukan pembayaran kepada E-Wallet Partner.
- E-Wallet Partner melakukan generate pesanan.
- NICEPAY menyimpan informasi pembayaran.
- Pada saat pembayaran:
- Jika Pelanggan menggunakan E-Wallet OVO, maka E-Wallet Partner akan mengimkan notifikasi kepada aplikasi terkait untuk melakukan pembayaran.
- Jika Pelanggan menggunakan E-Wallet lain (selain OVO dan AstraPay), maka E-Wallet Partner akan mengalihkan Pelanggan menuju halaman pembayaran Mitra. Kemudian, Pelanggan harus melakukan login dengan akun E-Wallet terkait sebelum melakukan proses pembayaran.
- Pelanggan mengirimkan pembayaran kepada E-Wallet Partner.
- E-Wallet Partner menerima pembayaran.
- E-Wallet Partner mengirimkan notifikasi kepada NICEPAY.
- NICEPAY menerima notifikasi.
- NICEPAY mengirimkan notifikasi kepada Merchant.
- Merchant menerima notifikasi.
- Merchant mengajukan pemeriksaan status kepada NICEPAY.
- NICEPAY mengirimkan response dari pemeriksaan status kepada Merchant.
- Merchant menerima status akhir.
- Merchant mengirimkan konfirmasi pesanan kepada Pelanggan.
AstraPay
Deskripsi alur saat melakukan pembayaran:
- Jika Pelanggan belum memiliki akun AstraPay:
- Pelanggan request checkout kepada Merchant.
- Merchant mengirimkan API Registration (nicepay/api/linkEnable.do) kepada NICEPAY.
- NICEPAY mengirimkan account link request kepada AstraPay.
- AstraPay menerima request yang dikirim oleh NICEPAY.
- AstraPay mengirimkan response pengalihan URL menuju halaman Mitra kepada NICEPAY.
- NICEPAY mengirimkan response pengalihan URL Mitra kepada Merchant.
- Merchant menampilkan halaman pendaftaran kepada Pelanggan.
- Pelanggan melakukan proses pendaftaran akun.
- Pelanggan mengirimkan pendaftaran akun kepada AstraPay.
- AstraPay melakukan validasi akun.
- AstraPay mengirimkan notifikasi kepada NICEPAY.
- NICEPAY mengirimkan notifikasi kepada Merchant.
- Merchant mengirimkan notifikasi bahwa akun sudah didaftarkan kepada Pelanggan.
- Pelanggan request checkout kepada Merchant.
- Merchant mengajukan transaksi (nicepay/api/linkInitiate.do) kepada NICEPAY.
- NICEPAY mengajukan transaksi kepada AstraPay.
- AstraPay melakukan generate transaksi.
- AstraPay mengirimkan response redirect URL kepada NICEPAY.
- NICEPAY mengirimkan response redirect URL halaman pembayaran kepada Merchant.
- Merchant mengalihkan Pelanggan kepada halaman pembayaran AstraPay.
- Pelanggan melakukan verifikasi pembayaran.
- Pelanggan melakukan pembayaran kepada AstraPay.
- AstraPay melakukan verifikasi pembayaran.
- AstraPay mengirimkan callback kepada NICEPAY.
- NICEPAY mengirimkan response kepada Merchant.
- Merchant menampilkan response callback kepada Pelanggan.
- AstraPay mengirimkan notifikasi kepada NICEPAY.
- NICEPAY menerima notifikasi.
- NICEPAY mengirimkan notifikasi kepada Merchant.
- Merchant menerima notifikasi.
- Merchant request pemeriksaan status pembayaran kepada NICEPAY.
- NICEPAY mengirimkan response kepada Merchant.
- Merchant menerima status akhir.
- Merchant memperbarui status transaksi kepada Pelanggan.
Perbedaan Alur Proses Checkout (Redirect)
Proses checkout memiliki dua perbedaan alur, yaitu asynchronous dan synchronous. Pada alur proses asynchronous, Pelanggan perlu memasukkan kredensial untuk masuk ke dalam aplikasi Partner sebelum melakukan pembayaran. Sementara untuk proses synchronous, Pelanggan tidak perlu memasukkan kredensial aplikasi terlebih dahulu dan dapat langsung melakukan pembayaran melalui notifikasi pembayaran yang dikirimkan pada aplikasi Pelanggan.
Perbedaan alur tersebut dapat dilihat pada dua alur proses E-Wallet di bawah ini.
Alur Proses Asynchronous
Deskripsi alur setelah melakukan checkout pesanan:
- Pelanggan requests checkout kepada Merchant.
- Merchant mengirimkan request checkout menggunakan API Registration kepada NICEPAY.
- NICEPAY mengirimkan response API Registration kepada Merchant.
- Merchant request API Payment kepada NICEPAY.
- NICEPAY mengajukan pembayaran kepada E-Wallet Partner dan menyimpan informasi pembayaran.
- E-Wallet Partner melakukan generate pesanan.
- NICEPAY menyimpan informasi pembayaran.
- Jika Pelanggan menggunakan E-Wallet lain (selain OVO dan AstraPay), maka E-Wallet Partner akan mengalihkan Pelanggan menuju halaman pembayaran Mitra.
- Pelanggan melakukan login dengan akun E-Wallet terkait sebelum melakukan proses pembayaran.
- Pelanggan mengirimkan pembayaran kepada E-Wallet Partner.
- E-Wallet Partner menerima pembayaran.
- E-Wallet Partner mengirimkan notifikasi kepada NICEPAY.
- NICEPAY menerima notifikasi.
- NICEPAY mengirimkan notifikasi kepada Merchant.
- Merchant menerima notifikasi.
- Merchant request pemeriksaan status kepada NICEPAY.
- NICEPAY mengirimkan response dari request pemeriksaan status kepada Merchant.
- Merchant menerima status terakhir.
- Merchant mengirimkan konfirmasi pesanan kepada Pelanggan.
Alur Proses Synchronous
Deskripsi alur setelah melakukan checkout pesanan:
- Pelanggan request checkout kepada Merchant.
- Merchant mengirimkan request checkout menggunakan API Registration kepada NICEPAY.
- NICEPAY mengirimkan response order regist kepada Merchant.
- Merchant mengirimkan API Payment kepada NICEPAY.
- NICEPAY mengajukan pembayaran kepada E-Wallet Partner.
- E-Wallet Partner melakukan generate pesanan.
- NICEPAY menyimpan informasi pembayaran.
- E-Wallet Partner (OVO) akan mengimkan notifikasi kepada aplikasi terkait untuk melakukan pembayaran.
- Pelanggan mengirimkan pembayaran kepada E-Wallet Partner.
- E-Wallet Partner menerima pembayaran.
- E-Wallet Partner mengirimkan notifikasi kepada NICEPAY.
- NICEPAY menerima notifikasi.
- NICEPAY mengirimkan notifikasi kepada Merchant.
- Merchant menerima notifikasi.
- Merchant request pemeriksaan status kepada NICEPAY.
- NICEPAY mengirimkan response dari request pemeriksaan status kepada Merchant.
- Merchant menerima status akhir.
- Merchant mengirimkan konfirmasi pesanan kepada Pelanggan.
NICEPAY Secure Payment Page
Gambar di atas adalah contoh pembayaran Checkout dengan metode E-Wallet menggunakan NICEPAY Secure Payment Page.
Setelah proses pengajuan registrasi pembayaran telah selesai, Anda dapat melanjutkan proses transaksi sampai dengan penyelesaian dengan mengikuti Panduan Bayar E-Wallet.
Catatan untuk E-Wallet ShopeePay dan OVO, silakan berikan pesan peringatan kepada Pelanggan untuk membuka melalui perangkat ponsel demi memberikan pengalaman lebih baik kepada Pelanggan.
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 | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
paymentURL Required | ANS | 14 | Payment URL | https://dev.nicepay.co.id/nicepay/redirect/v2/payment |
tXid Required | AN | 30 | Transaction ID | TNICEEW05100202212201020014087 |
Catatan untuk E-Wallet ShopeePay dan OVO, silakan berikan pesan peringatan kepada Pelanggan untuk membuka melalui perangkat ponsel demi memberikan pengalaman lebih baik kepada Pelanggan.
Response Parameter for E-Wallet - API Checkout (CallbackUrl)
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
resultCd | N | 4 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
tXid | AN | 30 | Transaction ID | IONPAYTEST00202212201351474222 When Success |
referenceNo | ANS | 40 | Order Number | ordNo20221220131215 When Success |
payMethod E-Wallet, Payloan | N | 2 | 05 When Success | |
amt | N | 12 | Transaction Amount | 5000 When Success |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20221220 When Success |
transTm | N | 6 | Transaction Time (HH24MISS) | 135201 When Success |
mitraCd Direct Debit, E-Wallet, Payloan | A | 4 | DANA When Success | |
callBackUrl | ANS | 255 | Payment Result URL | https://webhook.site/7bef799f-ebe2-4328-a7b3-6d53deedca27 When Success |
Catatan: Response parameter akan dikirimkan melalui callbackUrl dengan Content-type: application/json dan metode: POST Parameter.
Sample Parameter for E-Wallet - API Checkout (CallbackUrl)
Pada pembayaran saat Checkout, response dari request yang melalui hit adalah Callback URL.
Request Parameter
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
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
Saat Callback diterima callbackUrl Anda, kami merekomendasikan Merchant untuk melakukan verifikasi Status dengan menggunakan Status Inquiry - API Checkout.
Callback Handling sangat penting untuk membantu meminimalisir tindakan Fraud. Kami sangat merekomendasikan Merchant untuk melakukan verifikasi menggunakan Callback parameter.
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