Cancel - API Convenience Store
This API uses by Merchants to integrate the cancel system for Convenience Stores' payment method used by the Merchant. Transaction cancellation happens from either the Customer side or the Merchant.
- If the Customer changes their mind after proceeding with the order and requests cancellation from the Merchant before proceeding with the payment process.
- If there is a technical or non-technical issue when the Merchant processes the Customer's order.
Merchants can use this API so that the payment number issue can't be used anymore.
Payment number can only canceled before being paid before the payment process is executed.
If the Customer has proceeded with the payment process, the paid bill can't be canceled or refunded to the Customer through API.
The Convenience Store Cancel API uses for the cancel system for payments through 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 |
Code PayMethod
01 Credit Card
02 Virtual Account
03 Convenience Store
04 Direct Debit
05 E-Wallet
06 Payloan
08 QRIS
09 GPN
The following is a list of parameters for activating the cancel system for the Convenience Store payment method. These parameters use via the API testing platform.
Parameter | Type | Size | Description | Example / Notes |
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 | 03 | |
cancelType Required | N | 2 | | 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 | - |
Following are the response parameters from the results of the request parameters for the integration of the convenience store cancel:
Parameter | Type | Size | Description | Example / Notes |
resultCd | N | 4 | Result Code | 0000 |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
tXid | AN | 30 | Transaction ID | IONPAYTEST03202212121030529316 |
referenceNo | ANS | 40 | Merchant Order No | 815123412341 |
transDt | N | 8 | Transaction Date | 20221212 |
transTm | N | 6 | Transaction Time | 103052 |
description | AN | 255 | Description | test cancel |
amt | N | 12 | Amount | 10000 |