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

# Tentang Direct Debit - API Checkout&#x20;

***

API ini digunakan oleh Merchant untuk melakukan pengajuan pembayaran kepada NICEPAY untuk metode pembayaran Direct Debit menggunakan Checkout API.



# Alur Proses

***

![Alur Pembayaran Direct Debit (Click Pay)](https://app.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/8KMCainQ7lgYtOEZKbwlh_nicepay-archbee-payment-clickpay-new-clickpay-redirect.png "Alur Pembayaran Direct Debit (Click Pay)")

Deskripsi langkah:

1. Pelanggan mengajukan *checkout&#x20;*&#x6B;epada Merchant.
2. Merchant akan melakukan pendaftaran checkout menggunakan API Registration kepada NICEPAY.
3. NICEPAY menyimpan order regis&#x74;*.*
4. NICEPAY mengarahkan Merchant menuju halaman pembayaran NICEPAY.
5. Merchant menampilkan halaman pembayaran NICEPAY kepada Pelanggan.
6. Pelanggan memilih metode pembayaran.
7. Pelanggan memasukkan data pembayaran (Jenius: Cashtag).
8. Pelanggan mengirimkan metode pembayaran yang dipilih kepada NICEPAY.
9. NICEPAY mengajukan pembayaran kepada Bank.
10. Bank melakukan proses *authentication.*
11. Bank mengirimkan notifikasi *authentication&#x20;*&#x6B;epada Pelanggan.
12. Pelanggan melakukan *authentication.*
13. Pelanggan mengajukan *charge&#x20;*&#x6B;epada Bank.
14. Bank melakukan proses pembayaran.
15. Bank mengirimkan hasil pembayaran kepada Pelanggan.
16. Bank mengirimkan *push notification&#x20;*&#x6B;epada NICEPAY.
17. NICEPAY melakukan validasi notifikasi.
18. NICEPAY melakukan perubahan status.
19. NICEPAY mengirimkan notifikasi kepada Merchant.
20. Merchant mengajukan pemeriksaan status menggunakan API Status kepada NICEPAY.
21. NICEPAY mengirimkan *response&#x20;*&#x73;tatus kepada Merchant.
22. Merchant menerima status akhir.
23. Merchant mengirim konfirmasi perubahan status 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 dengan metode Direct Debit menggunakan NICEPAY Secure Payment Page.

![Direct Debit  - Secure Payment Page](https://api.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/Hi9iC4Ydspm3SLN-Dkw7o_image-id-direct-debit-secure-payment-page.jpg "Direct Debit  - Secure Payment Page")

Setelah memilih metode dengan Direct Debit, Anda akan dialihkan ke halaman untuk memilih layanan Direct Debit yang diinginkan. Selanjutnya, Anda akan dialihkan ke halaman *form* untuk memasukan identitas Anda. Pada contoh di atas, bila Anda memilih layanan Jenius, Anda akan diminta untuk memasukan data *Cashtag* Anda pada *form* yang telah disediakan. Setelah melengkapi *form*, Anda dapat melanjutkan proses pembayaran. Kemudian, Anda dapat melanjutkan sampai *order payment* sukses.

![Success - Secure Payment Page](https://api.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/ImvxatwsGqNZFY_UtbvpU_image-id-direct-debit-success-secure-payment-page.jpg "Success - Secure Payment Page")

Proses *request* registrasi pembayaran telah selesai. Anda dapat melanjutkan proses transaksi sampai dengan penyelesaian dengan mengikuti panduan [Panduan Bayar Direct Debit](docId\:eJ49bFx8eJVfBsoGQORTO).



# API Checkout Transaction Payment

***

| **API URL**         | `/nicepay/redirect/v2/payment`&#xD;         |
| ------------------- | ------------------------------------------- |
| **Request Method**  | `Redirect-GET`                              |
| **Header**          | `Content-Type: application/Form-UrlEncoded` |



## Request Parameter for Direct Debit - 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 /> | TNICECP04100202305250918306465                              |



## Response Parameter for Direct Debit - API Checkout (CallbackUrl)

***



| **Parameter**                                                                                                                           | **Tipe** | **Ukuran** | **Deskripsi**                                                                                                                               | **Contoh / Catatan**                                                                     |
| --------------------------------------------------------------------------------------------------------------------------------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `status`                                                                                                                                | N        | 1          | [Transaction Status](docId:8m3-7Smhm_jhdrE5pCRzp)                                                                                           | 0                                                                                        |
| `merchantToken`                                                                                                                         | AN       | 255        | Merchant Token                                                                                                                              | 46ca2f8a7b0b24ad57e49f879764718e40839f67d00c22b3f79ba328f2a0a8aa<br /><br />When Success |
| `goodsNm`<br /><font color="#2166ae">Direct Debit</font><font color="#2166ae">, E-Wallet, </font><font color="#2166ae">Payloan</font>   | AN       | 100        | Goods Name                                                                                                                                  | Jhon+Doe<br /><br />When Success                                                         |
| `billingNm`<br /><font color="#2166ae">Direct Debit</font><font color="#2166ae">, E-Wallet, </font><font color="#2166ae">Payloan</font> | A        | 100        | Billing Name                                                                                                                                | Jhon+Doe<br /><br />When Success                                                         |
| `referenceNo`                                                                                                                           | ANS      | 40         | Order Number                                                                                                                                | ORD20230525090536<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)                                                                                                  | JENC<br /><br />When Success                                                             |
| `tXid`                                                                                                                                  | AN       | 30         | Transaction ID                                                                                                                              | TNICECP04100202305250918306465<br /><br />When Success                                   |
| `amt`                                                                                                                                   | N        | 12         | Transaction Amount                                                                                                                          | 5000<br /><br />When Success                                                             |
| `receiptCode`                                                                                                                           | ANS      | 20         | Authorization Number                                                                                                                        | 951527524097<br /><br />When Success                                                     |
| `instmntType`                                                                                                                           | N        | 2          | [Installment Type Code](docId:7CIX-U_4z295XgtNVEsbO)                                                                                        | 2<br /><br />When Success                                                                |
| `instmntMon`                                                                                                                            | N        | 2          | Installment Month<br />`1`: 1 Month/Full Payment, jika `instmntType`*:* *null/1*<br />`3`: 3 Months<br />`6`: 6 Months<br />`12`: 12 Months | 1<br /><br />When Success                                                                |
| `matchCl`                                                                                                                               | N        | 1          | [Notification Match Amount Indicator](docId\:WdoGjBeqc1VmRdFJqG1ZE)                                                                         | 0<br /><br />When Success                                                                |
| `mRefNo`                                                                                                                                | AN       | 18         | Reference Number                                                                                                                            | 202305250918303<br /><br />When Success                                                  |
| `payMethod`                                                                                                                             | N        | 2          | [Payment Method Code](docId\:g7inRV70XcSA9lP7bpmok)                                                                                         | 04<br /><br />When Success                                                               |
| `currency`                                                                                                                              | A        | 3          | Currency                                                                                                                                    | IDR<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 Direct Debit - API Checkout (CallbackUrl)

***

:::hint{type="success"}
Pada pembayaran saat *Checkout*, *response&#x20;*&#x64;ari *request&#x20;*&#x79;ang di-*hit&#x20;*&#x61;dalah Callback URL.
:::

### Request Parameter

:::CodeblockTabs
cURL

```curl
curl -X GET "https://www.merchant.com/callbackUrl?resultCd=0000&resultMsg=Please+do+payment+on+jenius+pay+apps&tXid=TNICECP04100202305250918306465&referenceNo=ORD20230525090536&amt=&transDt=20230525&transTm=091830"
```
:::

### Callback Parameter

:::CodeblockTabs
Response Callback

```curl
merchantToken=46ca2f8a7b0b24ad57e49f879764718e40839f67d00c22b3f79ba328f2a0a8aa
goodsNm=Jhon+Doe
referenceNo=ORD20230525090536
mitraCd=JENC
tXid=TNICECP04100202305250918306465
amt=5000
receiptCode=951527524097
instmntType=2
billingNm=Jhon+Doe
matchCl=0
mRefNo=202305250918303
payMethod=04
currency=IDR
instmntMon=1
status=0
```
:::



## Callback Handling API Checkout Payment

***

:::hint{type="success"}
Saat *Callback&#x20;*&#x64;iterima `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/fzdlOKawzyYatnepwv43z_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=Please+do+payment+on+jenius+pay+apps&tXid=TNICECP04100202305250918306465&referenceNo=ORD20230525090536&amt=&transDt=20230525&transTm=091830
```

Response Callback

```json
merchantToken=46ca2f8a7b0b24ad57e49f879764718e40839f67d00c22b3f79ba328f2a0a8aa
goodsNm=Jhon+Doe
referenceNo=ORD20230525090536
mitraCd=JENC
tXid=TNICECP04100202305250918306465
amt=5000
receiptCode=951527524097
instmntType=2
billingNm=Jhon+Doe
matchCl=0
mRefNo=202305250918303
payMethod=04
currency=IDR
instmntMon=1
status=0
```
:::

