Cancel - API Virtual Account
This uses by s to integrate cancel for s. Transaction cancellation happens from either side or .
- If changes their mind after ing with and requests cancellation from before ing with .
- If there is a technical or non-technical issue when es 's .
s can use this so that issue can't be used anymore.
s can only canceled before being paid before is executed.
If has ed with , paid bill can't be canceled or refunded to through .
The Cancel is used for cancel on .
API Endpoint | /nicepay/direct/v2/cancel |
---|---|
Request Method | POST |
Header | Content-Type: application/json |
Merchant Token | SHA256(timeStamp+iMid+tXid+amt+merchantKey) |
Code PayMethod
01
02 Virtual Account
03
04
05
06
08
09
The following is a list of s for activating cancel on . These s are used via platform.
Parameter | Type | Size | Description | Example / Notes |
---|---|---|---|---|
timeStamp Required | N | 14 | Request | 20220623100659 |
tXid Required | AN | 30 | Transaction ID | NORMALTEST02202212150941111979 |
iMid Required | AN | 10 | ID | NORMALTEST |
payMethod Required | N | 2 | 02 | |
cancelType Required | N | 2 | | 1 |
merchantToken Required | AN | 255 | token | 94acd9768557df77de675b7b97658d6a743cc0675f4eb681c871c4e1b56c0b0f |
amt Required | N | 12 | Amount | 10000 |
cancelMsg | AN | 255 | Cancel Message | Testing Cancel of |
preauthToken | AN | 100 | Pre-Auth Token | d4ef98b26f917a697691807cf |
cancelServerIp | AN | 15 | Server IP | 127.0.0.1 |
cancelUserId | AN | 30 | User ID | |
cancelUserIp | AN | 15 | User IP | 127.0.0.1 |
cancelUserInfo | AN | 100 | User Information |
|
cancelRetryCnt | N | 2 | Retry Count | |
worker | AN | 10 | Worker | |
The following is a response from request results for 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 | NORMALTEST02202212150941111979 When Success |
referenceNo | ANS | 40 | Order Number | ordNo20221215091261 When Success |
transDt | N | 8 | Transaction Date | 20221215 When Success |
transTm | N | 6 | Transaction Time | 094111 When Success |
description | AN | 255 | Description | Testing Cancel of When Success
|
amt | N | 12 | Amount | 10000 When Success |