---
title: Cancel - API Direct Debit
slug: nicepay-api-non-snap-cancel-api-direct-debit
description: Informasi tentang API Non-SNAP Payment - Cancel - API Direct Debit yang terdapat pada sistem NICEPAY
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/51OGR_ycAPp_46XV8nsvm_rdrx9d8diaz-pgm07xfz2-test-1-1.png
icon: {"faIcon":"fa-solid fa-book"}
docTags: 
createdAt: 2022-12-01T07:52:37.000Z
---

# Tentang API Direct Debit Cancel

***

API ini digunakan Merchant untuk melakukan integrasi sistem *cancel* pada metode pembayaran Direct Debit.



# API Direct Debit Cancel

***

API Direct Debit Cancel digunakan untuk sistem pembatalan pada pembayaran melalui Direct Debit.

| **API End Point**  | `/nicepay/direct/v2/cancel`                           |
| ------------------ | ----------------------------------------------------- |
| **Request Method** | <font color="#3b9f0f">**POST**</font>****             |
| **Header**         | `Content-Type: application/json`                      |
| **Merchant Token** | SHA256(`timeStamp`+`iMid`+`tXid`+`amt`+`merchantKey`) |
| **Request Format** | `application/json`                                    |



# Payment Methods Available for Cancel

***

**Code**              **PayMethod**

***

`01`               Credit Card

***

`02`               Virtual Account&#x20;

***

`03`               <font color="#2166ae">**Convenience Store**</font>****

***

`04`               Direct Debit&#x20;

***

`05`               E-Wallet&#x20;

***

`06`               Paylater&#x20;

***

`08`               QRIS&#x20;

***

`09`               GPN&#x20;

***



## Request Parameters for Direct Debit Cancel

***

Berikut ini adalah daftar parameter untuk mengaktifkan sistem *cancel* pada metode pembayaran Direct Debit. Parameter ini digunakan melalui platform pengujian API. &#x20;

| **Parameter**                                               | **Tipe** | **Ukuran** | **Deskripsi**                                                                           | **Contoh / Catatan**                                             |
| ----------------------------------------------------------- | -------- | ---------- | --------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `timeStamp`<br /> <font color="#2166ae">Required</font>     | N        | 14         | API Request Timestamp <font color="#2166ae">
</font>                                    | 20230515141929                                                   |
| `tXid`<br /> <font color="#2166ae">Required</font>          | AN       | 30         | Transaction ID<br /><font color="#2166ae">
</font>&#xD;                                 | TNICECP04104202305151417238166                                   |
| `iMid`<br /> <font color="#2166ae">Required</font>          | AN       | 10         | Merchant ID<br /><font color="#2166ae">
</font>&#xD;                                    | TNICECP041                                                       |
| `payMethod`<br /> <font color="#2166ae">Required</font>     | N        | 2          | [Payment Method Code](docId\:g7inRV70XcSA9lP7bpmok) <font color="#2166ae">
</font>&#xD; | 04                                                               |
| `cancelType`<br /> <font color="#2166ae">Required</font>    | N        | 2          | [Cancel Type Code](docId\:Mq9xE7wdOPR8OkZ3v-pVc) <font color="#2166ae">
</font>&#xD;    | 1                                                                |
| `cancelMsg`                                                 | AN       | 255        | Cancel Message                                                                          | Request Cancel                                                   |
| `merchantToken`<br /> <font color="#2166ae">Required</font> | AN       | 255        | Merchant Token <br /><font color="#2166ae">
</font>                                     | 89fa33ec4c17f5048e69c404b42d07005f1dd6ab64354c583d04670cf9690ed8 |
| `amt`<br /> <font color="#2166ae">Required</font>           | N        | 12         | Payment Amount <font color="#2166ae">
</font>&#xD;                                      | 10000                                                            |
| `preauthToken`                                              | AN       | 100        | Pre-Auth Token&#xD;                                                                     |                                                                  |
| `cancelUserId`                                              | AN       | 30         | User ID&#xD;                                                                            | admin                                                            |



## Response Parameters for Direct Debit Cancel

***

Berikut adalah *response parameter* dari hasil *request parameter* untuk integrasi Direct Debit Cance&#x6C;*.*

| **Parameter**                                                           | **Tipe** | **Ukuran** | **Deskripsi**                                                                                                                 | **Contoh Catatan**                  |
| ----------------------------------------------------------------------- | -------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
| `resultCd`                                                              | N        | 4          | [Result Code](docId\:gvAdBBr0SQ92N1zHplSFM) [&#xD;](https://app.archbee.com/docs/36sM2OxRIwwbi9iNlqMTP/wpcEMaZro_Xvnxz-1ZAiB) | 0000                                |
| `resultMsg`                                                             | AN       | 255        | Result Message: [Error Code](docId\:yEh1VA9k2y6sL1kQF2aWD)&#xD;                                                               | SUCCESS                             |
| `tXid`                                                                  | AN       | 30         | Transaction ID&#xD;                                                                                                           | TNICECP04104202305151417238166&#xD; |
| `referenceNo`                                                           | ANS      | 40         | Merchant Order Number&#xD;                                                                                                    | 20230515141702                      |
| `transDt`                                                               | N        | 8          | Transaction Date&#xD;                                                                                                         | 20230515                            |
| `transTm`                                                               | N        | 6          | Transaction Time                                                                                                              | 141723                              |
| `amt`                                                                   | N        | 12         | Amount                                                                                                                        | 2000                                |
| `cancelReferenceNo`<br /><font color="#2166ae">(Optional For CC)</font> | ANS      | 40         | Merchant Cancel Number&#xD;                                                                                                   | CancelNo20230515141702              |



## Sample Parameter for Direct Debit Cancel

***

:::CodeblockTabs
JSON Request

```json
{
    "timeStamp":"20230515141929",
    "tXid":"TNICECP04104202305151417238166",
    "iMid":"TNICECP041",
    "payMethod":"04",
    "cancelType":"1",
    "cancelMsg":"Request Cancel",
    "merchantToken":"89fa33ec4c17f5048e69c404b42d07005f1dd6ab64354c583d04670cf9690ed8",
    "preauthToken":"",
    "amt":"10000",
    "cancalUserId":"admin"
}
```

JSON Response

```json
{
    "tXid": "TNICECP04104202305151417238166",
    "referenceNo": "20230515141702",
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "transDt": "20230515",
    "transTm": "141723",
    "amt": "2000",
    "cancelReferenceNo": "CancelNo20230515141702"
}
```

Java Request

```java
//Cancel Registration//
nicePay.setTimeStamp("20230515141929");
nicePay.setiMid("TNICECP041");
nicePay.setAmt("2000");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getMerchantToken());
nicePay.settXid("TNICECP04104202305151417238166");
nicePay.setPayMethod("04");
nicePay.setCancelType("1");
nicePay.setCancelMsg("Request Cancel");
nicePay.setCancalUserId("admin");


// Request Cancel
nicePay.cancel();

// Response String //
System.out.println("Final Response String : " + nicePay.getResponseString());

String resultCd = nicePay.Get("resultCd");
String resultMsg = nicePay.Get("resultMsg");
String tXid = nicePay.Get("tXid");
String referenceNo = nicePay.Get("referenceNo");
String amt = nicePay.Get("amt");
String cancelReferenceNo = nicePay.Get("cancelReferenceNo");
```
:::