Cancel - API E-Wallet
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 E-Wallet Cancel API uses for the cancel system for payments via E-Wallet.
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 E-Wallet payment method. These parameters are used via the API testing platform.
Parameter | Type | Size | Description | Example / Notes |
timeStamp Required | N | 14 | API Request Timestamp | 20180123100505 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST01202103311759347262 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
payMethod Required | N | 2 | 05 | |
cancelType Required | N | 2 | | 1 |
merchantToken Required | AN | 255 | merchant token | 66141d60572e570045c4f3e9965f3452d511496841981e8a2af6a24a7038a119 |
amt Required | N | 12 | Payment Amount | 10000 |
cancelMsg | AN | 255 | Cancel Message | Request Cancel |
cancelServerIp | AN | 15 | Server IP | 127.0.0.1 |
Following are the response parameters from the results of the request parameters for E-Wallet cancel handling:
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 | TNICEEW05105202212121343519502 |
referenceNo | ANS | 40 | Merchant Order No | 815123412341 |
transDt | N | 8 | Transaction Date | 20221212 |
transTm | N | 6 | Transaction Time | W134351 |
description | AN | 255 | Description | test cancel |
amt | N | 12 | Amount | 1 |