---
title: E-Wallet - API Checkout
slug: nicepay-api-e-wallet-payment-api-checkout
description: Informasi tentang API Checkout - Payment untuk metode pembayaran E-Wallet yang disediakan oleh NICEPAY
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/EVk0oKt9_aBEOuaFsWx6O_rdrx9d8diazpgm07xfz2test-1.png
icon: {"faIcon":"fa-solid fa-credit-card"}
docTags: 
createdAt: 2022-12-19T10:12:07.000Z
---

# 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

![Alur E-Wallet Umum](https://app.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/dgFfOnPXN5zcE4TO2R6yT_nicepay-archbee-payment-e-wallet-join.png "Alur E-Wallet Umum")

Deskripsi alur setelah melakukan checkout pesanan:

1. Pelanggan mengajukan *checkout *kepada Merchant.
2. Merchant mengirimkan pengajuan *checkout *menggunakan API Registration kepada NICEPAY.
3. NICEPAY mengirimkan *response *order regist kepada Merchant.
4. Merchant mengirimkan API Payment kepada NICEPAY.
5. NICEPAY mengajukan pembayaran kepada E-Wallet Partner.
6. E-Wallet Partner melakukan *generate *pesanan.
7. NICEPAY menyimpan informasi pembayaran.
8. 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.
9. Pelanggan mengirimkan pembayaran kepada E-Wallet Partner.
10. E-Wallet Partner menerima pembayaran.
11. E-Wallet Partner mengirimkan notifikasi kepada NICEPAY.
12. NICEPAY menerima notifikasi.
13. NICEPAY mengirimkan notifikasi kepada Merchant.
14. Merchant menerima notifikasi.
15. Merchant mengajukan pemeriksaan status kepada NICEPAY.
16. NICEPAY mengirimkan *response *dari pemeriksaan status kepada Merchant.
17. Merchant menerima status akhir.
18. Merchant mengirimkan konfirmasi pesanan kepada Pelanggan.



## AstraPay

![Alur E-Wallet AstraPay](https://app.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/kGt23r_YFA-1l9FANPAav_nicepay-archbee-payment-e-wallet-astrapay.png "Alur E-Wallet AstraPay")

Deskripsi alur saat melakukan pembayaran:

1. 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.
2. Pelanggan *request checkout *kepada Merchant.
3. Merchant mengajukan transaksi ([nicepay/api/linkInitiate.do](#)) kepada NICEPAY.
4. NICEPAY mengajukan transaksi kepada AstraPay.
5. AstraPay melakukan *generate *transaksi.
6. AstraPay mengirimkan *response *redirect URL kepada NICEPAY.
7. NICEPAY mengirimkan *response *redirect URL halaman pembayaran kepada Merchant.
8. Merchant mengalihkan Pelanggan kepada halaman pembayaran AstraPay.
9. Pelanggan melakukan verifikasi pembayaran.
10. Pelanggan melakukan pembayaran kepada AstraPay.
11. AstraPay melakukan verifikasi pembayaran.
12. AstraPay mengirimkan *callback *kepada NICEPAY.
    - NICEPAY mengirimkan *response *kepada Merchant.
    - Merchant menampilkan *response callback *kepada Pelanggan.
13. AstraPay mengirimkan notifikasi kepada NICEPAY.
    - NICEPAY menerima notifikasi.
    - NICEPAY mengirimkan notifikasi kepada Merchant.
    - Merchant menerima notifikasi.
14. Merchant *request* pemeriksaan status pembayaran kepada NICEPAY.
15. NICEPAY mengirimkan *response *kepada Merchant.
16. Merchant menerima status akhir.
17. 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

![Alur Proses Asynchronouse pada E-Wallet](https://app.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/Ro3IEekft89HgP9w5IyB-_nicepay-archbee-payment-e-wallet.png "Alur Proses Asynchronouse pada E-Wallet")

Deskripsi alur setelah melakukan *checkout *pesanan:

1. Pelanggan *requests checkout* kepada Merchant.
2. Merchant mengirimkan *request checkout* menggunakan API Registration kepada NICEPAY.
3. NICEPAY mengirimkan *response *API Registration kepada Merchant.
4. Merchant *request *API Payment kepada NICEPAY.
5. NICEPAY mengajukan pembayaran kepada E-Wallet Partner dan menyimpan informasi pembayaran.
6. E-Wallet Partner melakukan *generate *pesanan.
7. NICEPAY menyimpan informasi pembayaran.
8. Jika Pelanggan menggunakan E-Wallet lain (selain OVO dan AstraPay), maka E-Wallet Partner akan mengalihkan Pelanggan menuju halaman pembayaran Mitra. 
9. Pelanggan melakukan *login *dengan akun E-Wallet terkait sebelum melakukan proses pembayaran.
10. Pelanggan mengirimkan pembayaran kepada E-Wallet Partner.
11. E-Wallet Partner menerima pembayaran.
12. E-Wallet Partner mengirimkan notifikasi kepada NICEPAY.
13. NICEPAY menerima notifikasi.
14. NICEPAY mengirimkan notifikasi kepada Merchant.
15. Merchant menerima notifikasi.
16. Merchant *request* pemeriksaan status kepada NICEPAY.
17. NICEPAY mengirimkan *response *dari *request* pemeriksaan status kepada Merchant.
18. Merchant menerima status terakhir.
19. Merchant mengirimkan konfirmasi pesanan kepada Pelanggan.



### Alur Proses Synchronous

![Alur Proses Synchronouse pada e-Wallet](https://app.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/n7SzPqy6DiTnzKxGH89bM_nicepay-archbee-payment-ewallet-ovo.png "Alur Proses Synchronouse pada e-Wallet")

Deskripsi alur setelah melakukan *checkout *pesanan:

1. Pelanggan *request checkout* kepada Merchant.
2. Merchant mengirimkan *request checkout* menggunakan API Registration kepada NICEPAY.
3. NICEPAY mengirimkan *response *order regist kepada Merchant.
4. Merchant mengirimkan API Payment kepada NICEPAY.
5. NICEPAY mengajukan pembayaran kepada E-Wallet Partner.
6. E-Wallet Partner melakukan *generate *pesanan.
7. NICEPAY menyimpan informasi pembayaran.
8. E-Wallet Partner (OVO) akan mengimkan notifikasi kepada aplikasi terkait untuk melakukan pembayaran.
9. Pelanggan mengirimkan pembayaran kepada E-Wallet Partner.
10. E-Wallet Partner menerima pembayaran.
11. E-Wallet Partner mengirimkan notifikasi kepada NICEPAY.
12. NICEPAY menerima notifikasi.
13. NICEPAY mengirimkan notifikasi kepada Merchant.
14. Merchant menerima notifikasi.
15. Merchant *request* pemeriksaan status kepada NICEPAY.
16. NICEPAY mengirimkan *response *dari *request* pemeriksaan status kepada Merchant.
17. Merchant menerima status akhir.
18. Merchant mengirimkan konfirmasi pesanan kepada Pelanggan.



# NICEPAY Secure Payment Page

***

![Secure Payment Page](https://api.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/ohh_r6otn4iPQSs_4RfL1_image-id-nicepay-secure-payment-page-main-dashboard.jpg "Secure Payment Page")

Gambar di atas adalah contoh pembayaran *Checkout *dengan metode E-Wallet menggunakan NICEPAY Secure Payment Page.

![E-Wallet  - Secure Payment Page](https://api.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/pnNEHqJccO1szcPrcVeX-_image-id-e-wallet-secure-payment-page.jpg "E-Wallet  - Secure Payment Page")

Setelah proses pengajuan registrasi pembayaran telah selesai, Anda dapat melanjutkan proses transaksi sampai dengan penyelesaian dengan mengikuti  [Panduan Bayar E-Wallet](docId:-v30F8TW2bUenjkPfjaX5).

![Success  - Secure Payment Page](https://api.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/IW-LY2xKXixI9Vqvy1O3-_image-id-e-wallet-success-secure-payment-page.jpg "Success  - Secure Payment Page")

:::hint{type="warning"}
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`  <br /><font color="#2166ae">Required</font> | ANS      | 14         | Payment URL<br />     | https\://dev.nicepay.co.id/nicepay/redirect/v2/payment&#xD; |
| `tXid` <br /><font color="#2166ae">Required</font>        | AN       | 30         | Transaction ID	<br /> | TNICEEW05100202212201020014087                              |

:::hint{type="warning"}
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          | [Result Code](docId\:gvAdBBr0SQ92N1zHplSFM)                 | 0000                                                                               |
| `resultMsg`                                                                                                                           | AN       | 255        | Result Message: [Error Code](docId\:yEh1VA9k2y6sL1kQF2aWD)  | SUCCESS                                                                            |
| `tXid`                                                                                                                                | AN       | 30         | Transaction ID	                                             | IONPAYTEST00202212201351474222<br /><br />When Success                             |
| `referenceNo`                                                                                                                         | ANS      | 40         | Order Number                                                | ordNo20221220131215<br /><br />When Success                                        |
| `payMethod`<br /><font color="#2166ae">E-Wallet, </font><font color="#2166ae">Payloan</font>                                          | N        | 2          | [Payment Method Code](docId\:g7inRV70XcSA9lP7bpmok)         | 05<br /><br />When Success                                                         |
| `amt`                                                                                                                                 | N        | 12         | Transaction Amount                                          | 5000<br /><br />When Success                                                       |
| `transDt`<br />                                                                                                                       | N        | 8          | Transaction Date (`YYYYMMDD`)                               | 20221220	<br /><br />When Success                                                  |
| `transTm`<br />                                                                                                                       | N        | 6          | Transaction Time (`HH24MISS`)                               | 135201<br /><br />When Success                                                     |
| `mitraCd`<br /><font color="#2166ae">Direct Debit</font><font color="#2166ae">, E-Wallet, </font><font color="#2166ae">Payloan</font> | A        | 4          | [Mitra Code](docId\:DwzaQDD7DXZMECz80A6o8)                  | DANA<br /><br />When Success                                                       |
| `callBackUrl`                                                                                                                         | ANS      | 255        | Payment Result URL                                          | https\://webhook.site/7bef799f-ebe2-4328-a7b3-6d53deedca27<br /><br />When Success |

:::hint{type="info"}
Catatan: Response parameter akan dikirimkan melalui `callbackUrl` dengan Content-type: `application/json` dan metode: `POST Parameter`.
:::


Sample Parameter for E-Wallet - API Checkout (CallbackUrl)
----------------------------------------------------------

***

:::hint{type="success"}
Pada pembayaran saat *Checkout*, *response* dari *request* yang melalui *hit* adalah Callback URL.
:::

### Request Parameter

:::CodeblockTabs
cURL

```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

:::CodeblockTabs
Response Callback

```curl
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

***

:::hint{type="success"}
Saat Callback diterima `callbackUrl` Anda, kami merekomendasikan Merchant untuk melakukan verifikasi Status dengan menggunakan [Status Inquiry - API Checkout](docId\:K9vBS87ev9_w5oJAU0et3).
:::

:::hint{type="warning"}
`Callback Handling` sangat penting untuk membantu meminimalisir tindakan *Fraud*. Kami sangat merekomendasikan Merchant untuk melakukan verifikasi menggunakan `Callback parameter`.
:::

::Image[]{src="https://app.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/WKbTcgF46-td5RYqdl0m4_nicepay-api-checkout-api-callback-handling-flow-1.png" size="50" width="370" height="361" position="center" caption="Alur Callback Handling" alt="Alur Callback Handling" darkWidth="370" darkHeight="361" showCaption="true"}

:::CodeblockTabs
URL Callback

```json
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

```json
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
```
:::