---
title: Hands On API
slug: hands-on-api
description: Ikuti panduan cepat integrasi untuk mulai menggunakan API NICEPAY
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/CN32j6Nfb5iayUWI1xIVH_rdrx9d8diazpgm07xfz2test-1.png
icon: {"faIcon":"fa-solid fa-terminal"}
docTags: 
createdAt: 2022-08-11T02:26:29.000Z
---

Nikmati produk dan layanan NICEPAY dengan *single integrated&#x20;*&#x41;PI dari kami yang aman serta mudah untuk integrasi dengan bisnis Anda. Mulai dengan proses integrasi yang cepat hanya dalam 15 menit!

# Prasyarat

***

1. MID/iMid (Merchant ID).
2. API Key (Merchant Key).
3. NICEPAY SDK *-&#x20;*&#x4F;ptiona&#x6C;*.*

:::hint{type="info"}
Silakan periksa prasyarat pada halaman [Authentication](docId:_D-kQ0wA0XWRFReEX8mQd) terlebih dahulu.
:::



# Alur Pembayaran

***

![](https://api.archbee.com/api/optimize/ueSgidS-H3kdWkcRhVS2v-SP0ELo5L25srBTg1gAbja-20240821-024827.jpg "Alur Pembayaran Checkout Credit Card")

Deskripsi langkah alur pembayaran kartu kredit redirect dengan 3Ds:&#x20;

1. Pelanggan melakukan *checkout*.
2. Pelanggan mengirim data *checkout* kepada Merchant.
3. Merchant mengajukan *checkout&#x20;*&#x6D;enggunakan API Registration kepada NICEPAY.
4. NICEPAY mendaftarkan data *checkout*.
5. NICEPAY mengalihkan pembayaran kepada halaman milik NICEPAY kepada Merchant.
6. Merchant mengirimkan halaman pembayaran NICEPAY kepada Pelanggan.
7. Pelanggan memilih metode pembayaran.
8. Pelanggan memasukkan data kartu.
9. Pelanggan mengirimkan Informasi data kartu kepada NICEPAY.
10. NICEPAY memproses kalkulasi FDS.
11. NICEPAY mengajukan 3Ds kepada Bank.
12. Bank melakukan validasi 3Ds.
13. Bank mengirimkan *response&#x20;*&#x55;RL 3Ds kepada NICEPAY.
14. NICEPAY menerima *response&#x20;*&#x76;erifikasi.
15. NICEPAY mengalihkan Pelanggan kepada halaman autentikasi ACS.
16. Bank membuat *response&#x20;*&#x4F;TP.
17. Bank mengirimkan OTP kepada Pelanggan.
18. Pelanggan menerima OTP.
19. Pelanggan memasukkan OTP.
20. Pelanggan mengirimkan OTP kepada Bank.
21. Bank melakukan verifikasi OTP.
22. Bank mengirimkan hasil 3Ds kepada NICEPAY.
23. NICEPAY menerima hasil pemeriksaan.
24. NICEPAY mengajukan pembayaran kepada Bank.
25. Bank melakukan proses pembayaran.
26. Bank mengirimkan notifikasi pembayaran kepada NICEPAY.
27. NICEPAY melakukan *redirect* `callbackUrl` kepada Merchant.
28. Merchant menampilkan hasil `callbackUrl` kepada Pelanggan.
29. NICEPAY mengirim notifikasi pembayaran kepada Merchant.
30. Merchant menerima notifikasi.
31. Merchant melakukan pengajuan inquiry ke NICEPAY.
32. NICEPAY menerima pengajuan.
33. NICEPAY secara otomatis mengirimkan *response&#x20;*&#x69;nquiry kepada Merchant.
34. Merchant menerima status terakhir.
35. Merchant mengirim halaman hasil transaksi kepada Pelanggan.



# Integrasi Pembayaran

***

Dalam proses ini, Anda akan menggunakan produk [Checkout](docId\:yxIg_kKwRUKCb_lTM_1bc) kami. Seluruh transaksi pada [API Checkout](docId\:Djp90D-rlCNeDCzKwGC-d) akan melakukan *redirect* ke **NICEPAY Secure Payment Page** sebagai proses pembayaran.

Ikuti lima langkah mudah di bawah ini untuk melakukan integrasi pembayaran dengan NICEPAY.

1. Melakukan panggilan API **Transaction Registration**.
2. Redirect ke **NICEPAY** **Secure Payment Page**.
3. Proses Pembayaran di **NICEPAY Secure Payment Page**.
4. **NICEPAY** akan melakuka&#x6E;*&#x20;redirect End-User&#x20;*&#x6B;e `callbackUrl` Merchant.
5. Merchant melakukan panggilan API **Status Inquiry API**.



## Transaction Registration

***

| **API End Point**  | [`https://dev.nicepay.co.id/nicepay/redirect/v2/registration`](https://dev.nicepay.co.id/nicepay/redirect/v2/registration) |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------- |
| **Request Method** | <font color="#3b9f0f">**POST**</font>****                                                                                  |
| **Header**         | `Content-Type: application/json`                                                                                           |
| **Description**    | Perform Transaction Registration                                                                                           |
| **Merchant Token** | `SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)`                                                                       |

:::CodeblockTabs
Request

```json
{
    "timeStamp":"20221012080918",
    "iMid":"IONPAYTEST",
    "payMethod":"00",
    "currency":"IDR",
    "amt":"10000",
    "referenceNo":"ORDER20221012080918",
    "callBackUrl":"https://dev.nicepay.co.id/IONPAY_CLIENT/paymentResult.jsp",
    "goodsNm":"Test Transaction Nicepay",
    "billingNm":"John Doe",
    "billingPhone":"081288998899",
    "billingEmail":"john.doe@example.com",
    "billingAddr":"Jln. Raya Kasablanka Kav.88",
    "billingCity":"South Jakarta",
    "billingState":"DKI Jakarta",
    "billingPostCd":"12800",
    "billingCountry":"Indonesia",
    "deliveryNm":"delivery@example.com",
    "deliveryPhone":"081288998899",
    "deliveryAddr":"Jln. Raya Kasablanka Kav.88",
    "deliveryCity":"South Jakarta",
    "deliveryState":"DKI Jakarta",
    "deliveryPostCd":"12800",
    "deliveryCountry":"Indonesia",
    "dbProcessUrl":"https://merchant.com/api/dbProcessUrl/Notif",
    "merchantToken":"d8d0968892c568bc6ff5adc17cd755f85334a0b58fce85392682993a9ba653ed",
    "userIP":"127.0.0.1",
    "cartData": "{\"count\":3,\"item\":[{\"goods_id\":30,\"goods_name\":\"Beanie\",\"goods_type\":\"Accessories\",\"goods_amt\":1000,\"goods_sellers_id\":\"NICEPAY-NamaMerchant\",\"goods_sellers_name\":\"NICEPAYSHOP\",\"goods_quantity\":1,\"goods_url\":\"http://www.nicestore.com/product/beanie/\"},{\"goods_id\":31,\"goods_name\":\"Belt\",\"goods_type\":\"Accessories\",\"goods_amt\":5000,\"goods_sellers_id\":\"NICEPAY-NamaMerchant\",\"goods_sellers_name\":\"NICEPAYSHOP\",\"goods_quantity\":1,\"goods_url\":\"http://www.nicestore.store/product/belt/\"},{\"img_url\":\"http://www.jamgora.com/media/avatar/noimage.png\",\"goods_name\":\"Shipping Fee\",\"goods_id\":\"Shipping for Ref. No. 278\",\"goods_detail\":\"Flat rate\",\"goods_type\":\"Shipping with Flat rate\",\"goods_amt\":\"4000\",\"goods_sellers_id\":\"NICEPAY-NamaMerchant\",\"goods_sellers_name\":\"NICEPAYSHOP\",\"goods_quantity\":\"1\",\"goods_url\":\"https://wwww.nicestore.store\"}]}",
    "sellers":"[{\"sellersId\":\"NICEPAY-NamaMerchant\",\"sellersNm\":\"NICEPAYSHOP\",\"sellersUrl\":\"http://nicestore.store/product/beanie/\",\"sellersEmail\":\"Nicepay@nicepay.co.id\",\"sellersAddress\":{\"sellerNm\":\"NICEPAYSHOP\",\"sellerLastNm\":\"NICEPAYSHOP\",\"sellerAddr\":\"Jln. Kasablanka Kav 88\",\"sellerCity\":\"Jakarta\",\"sellerPostCd\":\"14350\",\"sellerPhone\":\"082111111111\",\"sellerCountry\":\"ID\"}}]",
    "instmntType": "2",
    "instmntMon": "1",
    "recurrOpt":"0",
    "bankCd":"",
    "mitraCd":"",
    "merFixAcctId":"",
    "vacctValidDt":"",
    "vacctValidTm":""
}
```

Response

```json
{
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "tXid": "IONPAYTEST00202212191025073439",
    "referenceNo": "ORDER20221012080918",
    "payMethod": "00",
    "amt": "10000",
    "transDt": "20221219",
    "transTm": "102508",
    "description": null,
    "currency": "IDR",
    "goodsNm": "Test Transaction Nicepay",
    "billingNm": "John Doe",
    "payValidDt": null,
    "payValidTm": null,
    "paymentURL": "https://dev.nicepay.co.id/nicepay/redirect/v2/payment"
}
```
:::

:::hint{type="success"}
Akses spesifikasi API lebih lengkap di [Registration - API Checkout](docId:1y_mEI3eZUS-XW2YPhGyp).&#x20;
:::



## Transaction Payment

***

| **API End Point**  | [`https://dev.nicepay.co.id/nicepay/redirect/v2/payment`](https://dev.nicepay.co.id/nicepay/redirect/v2/payment) |
| ------------------ | ---------------------------------------------------------------------------------------------------------------- |
| **Request Method** | ****<font color="#3b9f0f">**GET**</font>****                                                                     |
| **Header**         | `Content-Type: application/Form-UrlEncoded`                                                                      |
| **Description**    | Perform Transaction Registration                                                                                 |
| **Merchant Token** | `SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)`                                                             |

Setelah mendapatkan *response*, Anda dapat mengalihkan Pelanggan menuju halaman pembayaran NICEPAY. Tautan tersebut merupakan penggabungan *Response Parameter* `paymentURL`+`tXid` `https://dev.nicepay.co.id/nicepay/redirect/v2/payment?tXid=IONPAYTEST00202212191025073439`.

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

![NICEPAY Payment Page](https://api.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/ojhnI_sZwKQea4vXtTgBj_image-id-kartu-kredit-success-secure-payment-page.jpg "NICEPAY Payment Page")

:::hint{type="success"}
Contoh di atas merupakan **Transaction Payment** menggunakan metode pembayaran Kartu Kredit. Temukan spesifikasi API lebih lengkap di [Credit Card - API Checkout](docId\:uue8Nk9jvMflKwGFDjm2J).
:::



## Callback Handling

***

Setelah *User&#x20;*&#x6D;emilih metode pembayaran Kartu Kredit, *User&#x20;*&#x61;kan dikembalikan ke halaman Merchant `callbackUrl` dengan metode **POST** dan pengiriman parameter.

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

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

:::hint{type="warning"}
`CallBack Handling` sangat penting untuk membantu meminimalisir tindakan *Fraud*. Kami sangat merekomendasikan Merchant untuk melakukan verifikasi menggunakan `callBack parameter`.&#x20;
:::

:::CodeblockTabs
callbackUrl

```json
"callbackUrl" : "https://www.merchant.com/callbackUrl/"
```

Callback Parameter

```json
{
    "resultCd":"0000",
    "resultMsg":"SUCCESS",
    "tXid":"IONPAYTEST01202212141112221428",
    "referenceNo":"",
    "payMethod":"01",
    "amt":"10000",
    "transDt":"20221212",
    "transTm":"121212",
    "description":"Testing Credit Card Transaction",
    "authNo":"080623",
    "issuBankCd":"OTHR"
    "acquBankCd":"BMRI",
    "cardNo":"453211*****1111",
    "goodsNm":"Test Transaction Nicepay"
    "billingNm":"John Doe",
    "currency":"IDR",
    "timeStamp":"20221212121212",
    "merchantToken":"2035d2295d9578fffb40137186f0203474142ae3e57992d4847826c5fcaffce6",
    "cardExpYymm":"2712",
    "instmntMon":"1",
    "instmntType":"1",
    "ccTransType":"1"
}
```
:::

Selamat! Anda telah berhasil melakukan percobaan integrasi!

Jelajahi lebih jauh melalui tautan di bawah ini.



# See Also

::::VerticalSplit{layout="middle"}
:::VerticalSplitItem
Temukan penjelasan terkait metode pembayaran dan produk kustomisasi pada halaman [Payment](docId\:cN5a57Nq9RzMUjE9FDnWm).
:::

:::VerticalSplitItem
Temukan penjelasan terkait produk yang sudah disediakan NICEPAY pada halaman [Checkout](docId\:yxIg_kKwRUKCb_lTM_1bc).
:::
::::

::::VerticalSplit{layout="middle"}
:::VerticalSplitItem
Kunjungi halaman [Payout](docId:_tBoQGqS-T6sk-ziXQl55) untuk mempelajari produk terbaru NICEPAY.
:::

:::VerticalSplitItem
Kunjungi halaman [Messaging](docId\:TUr_6cb3iEKRgA0L6OO46) untuk mempelajari layanan mengirim pesan yang dimiliki NICEPAY.
:::
::::

