Cancel - API QRIS
This API uses to cancel a transaction that has been paid. If the transaction cancels before the settlement process is complete, the transaction is considered void, and the transaction funds will return to the Customer.
The QRIS Cancel API uses for the cancel system for payments via QRIS.
API End Point | /nicepay/direct/v2/cancel |
Request Method | POST |
Header | Content-Type: application/json |
Merchant Token | SHA256(timeStamp+iMid+tXid+amt+merchantKey) |
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 requesting integration of the cancel payment process on the QRIS payment method. These parameters are used via the API testing platform.
Parameter | Type | Size | Description | Example / Notes |
timeStamp Required | N | 14 | API Request Timestamp | 20221208091279 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST08202212080951090538 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
payMethod Required | N | 2 | 08 | |
cancelType Required | N | 2 | 1 | |
merchantToken Required | AN | 255 | Merchant Token | 4f875d8ea982affbf29b11cf0d3811918dcd4400298eccadb929711d1f6f24d6 |
amt Required | N | 12 | Payment Amount | 5 |
cancelMsg | AN | 255 | Cancel Message | Request Cancel |
cancelServerIp | AN | 15 | Server IP | |
cancelUserId | AN | 30 | User ID | admin |
cancelUserIp | AN | 15 | User IP |
|
cancelUserInfo | AN | 100 | User Information | Request Cancel |
cancelRetryCnt | N | 2 | Retry Count | |
worker | AN | 10 | Worker | nicepay |
Following are the response parameters from the results of the request parameters for canceling QRIS handling:
Parameter | Type | Size | Description | Example / Notes |
resultCd | N | 4 | Result Code | 0000 |
resultMsg | AN | 255 | Result Message: | SUCCESS |
tXid | AN | 30 | Transaction ID | IONPAYTEST08202212080951090538 |
referenceNo | ANS | 40 | Merchant Order No | ORD54321 |
transDt | N | 8 | Transaction Date | 20221208 |
transTm | N | 6 | Transaction Time | 095155 |
amt | N | 12 | Amount | 5 |