---
title: Cancel - API Convenience Store
slug: nicepay-api-non-snap-cancel-api-convenience-store
description: Informasi tentang API Non-SNAP Payment - Cancel - API Convenience Store yang terdapat pada sistem NICEPAY
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/Il6nZyYbrOQ3uulR6ohXf_rdrx9d8diaz-pgm07xfz2-test-1-1.png
icon: {"faIcon":"fa-solid fa-book"}
docTags:
createdAt: 2022-12-01T07:51:47.000Z
---
# Tentang API Convenience Store Cancel
***
API Convenience Store Cancel ini digunakan untuk mengintegrasikan *cancel *atau pembatalan pembayaran pada metode pembayaran Convenience Store yang digunakan oleh Merchant. Pembatalan transaksi dapat terjadi baik dari sisi Pelanggan maupun Merchant.
1. Jika Pelanggan berubah pikiran setelah melakukan suatu pemesanan dan mengajukan pembatalan kepada Merchant sebelum melakukan proses pembayaran.
2. Jika pada saat Merchant melakukan proses pada pesanan Pelanggan terjadi kendala baik teknis maupun non-teknis.
Merchant dapat menggunakan API ini agar nomor pembayaran yang sudah terbit tidak bisa digunakan.
:::hint{type="warning"}
Nomor pembayaran yang sudah dibuat **hanya dapat dibatalkan** sebelum proses pembayaran berlangsung via API.
Apabila Pelanggan sudah melakukan proses pembayaran, tagihan yang sudah dibayarkan tidak bisa dibatalkan atau dilakukan pengembalian dana pada Pelanggan melalui API.
:::
# API Convenience Store Cancel
***
API Cancel Convenience Store digunakan untuk sistem *cancel* melalui metode Convenience Store.
| **API End Point** | `/nicepay/direct/v2/cancel` |
| ------------------ | ----------------------------------------------------- |
| **Request Method** | **POST** |
| **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
***
`03` **Convenience Store******
***
`04` Direct Debit
***
`05` E-Wallet
***
`06` Paylater
***
`08` QRIS
***
`09` GPN
***
## Request Parameters for Convenience Store Cancel
***
Berikut ini adalah daftar parameter untuk mengaktifkan sistem *cancel* pada metode pembayaran Convenience Store. Parameter ini digunakan melalui platform pengujian API.
| **Parameter** | **Tipe** | **Ukuran** | **Deskripsi** | **Contoh / Catatan** |
| ----------------------------------------------------------- | -------- | ---------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `timeStamp`
Required | N | 14 | API Request Timestamp
| 20221212101278 |
| `tXid`
Required | AN | 30 | Transaction ID
| IONPAYTEST03202212121030529316 |
| `iMid`
Required | AN | 10 | Merchant ID
| IONPAYTEST |
| `payMethod`
Required | N | 2 | [Payment Method Code](docId\:g7inRV70XcSA9lP7bpmok)
| 03 |
| `cancelType`
Required | N | 2 | [Cancel Type Code](docId\:Mq9xE7wdOPR8OkZ3v-pVc)
| 1 |
| `cancelMsg` | AN | 255 | Cancel Message | Request Cancel |
| `merchantToken`
Required | AN | 255 | Merchant Token
| 49974dde3c4a311030bd2095431443ce3689d79c90caaa88f4186050abb77cf9 |
| `amt`
Required | N | 12 | Payment Amount
| 10000 |
| `preauthToken` | AN | 100 | Pre-Auth Token
| - |
## Response Parameters for Convenience Store Cancel
***
Berikut adalah *response* parameter dari hasil *request *parameter untuk integrasi Convenience Store *cancel.*
| **Parameter** | **Tipe** | **Ukuran** | **Deskripsi** | **Contoh / Catatan** |
| ------------- | -------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
| `resultCd` | N | 4 | [Result Code](docId\:gvAdBBr0SQ92N1zHplSFM) [
](https://app.archbee.com/docs/36sM2OxRIwwbi9iNlqMTP/wpcEMaZro_Xvnxz-1ZAiB) | 0000 |
| `resultMsg` | AN | 255 | Result Message: [Error Code](docId\:yEh1VA9k2y6sL1kQF2aWD)
| SUCCESS |
| `tXid` | AN | 30 | Transaction ID
| IONPAYTEST03202212121030529316
|
| `referenceNo` | ANS | 40 | Merchant Order Number
| 815123412341
|
| `transDt` | N | 8 | Transaction Date
| 20221212
|
| `transTm` | N | 6 | Transaction Time | 103052
|
| `description` | AN | 255 | Description | test cancel
|
| `amt` | N | 12 | Amount | 10000
|
## Response Parameter for Convenience Store Cancel
***
:::CodeblockTabs
JSON Request
```json
{
"timeStamp":"20221212101278",
"tXid":"IONPAYTEST03202212121030529316",
"iMid":"IONPAYTEST",
"payMethod":"03",
"cancelType":"1",
"cancelMsg":"Request Cancel",
"merchantToken":"49974dde3c4a311030bd2095431443ce3689d79c90caaa88f4186050abb77cf9",
"preauthToken":"",
"amt":"10000"
}
```
JSON Response
```json
{
"tXid": "IONPAYTEST03202212121030529316",
"referenceNo": "815123412341",
"resultCd": "0000",
"resultMsg": "SUCCESS",
"transDt": "20221212",
"transTm": "103052",
"description": "test cancel",
"amt": "10000"
}
```
Java Request
```java
//Cancel Registration//
nicePay.setTimeStamp("20221208091279");
nicePay.setiMid("IONPAYTEST");
nicePay.setAmt("5");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getMerchantToken());
nicePay.settXid("IONPAYTEST08202212080951090538");
nicePay.setPayMethod("03");
nicePay.setCancelType("1");
nicePay.setCancelMsg("Request Cancel");
// 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");
```
:::