Cancel - API GPN
This uses to cancel paid . If cancels before settlement is done, then that will consider void, and that fund will return to Your .
The uses to cancel for s via .
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
03
04
05
06
08
09 GPN
The following is a list of s for requesting of cancel on . These s use via platform.
Parameter | Type | Size | Description | Example / Notes |
---|---|---|---|---|
timeStamp Required | N | 14 | Request Timestamp | 20180123100505 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST01202103311759347262 |
iMid Required | AN | 10 | ID | IONPAYTEST |
payMethod Required | N | 2 | Method | 09 |
cancelType Required | N | 2 | Cancel Type | 1 |
merchantToken Required | AN | 255 | Token | 66141d60572e570045c4f3e9965f3452d511496841981e8a2af6a24a7038a119 |
amt Required | N | 12 | Amount | 10000 |
cancelMsg | AN | 255 | Cancel Message | Request Cancel |
preauthToken | AN | 100 | Pre-Auth Token | |
referenceNo (Optional For CC) | ANS | 40 | Cancel Number | CancelNo20160525000-52104 |
cancelServerIp | AN | 15 | Server IP | 127.0.0.1 |
cancelUserId | AN | 30 | User ID | admin |
cancelUserIp | AN | 15 | User IP | 127.0.0.1 |
cancelUserInfo | AN | 100 | User Information | Test Cancel |
cancelRetryCnt | N | 2 | Retry Count | 3 |
worker | AN | 10 | Worker | |
Following are response s from results of request s for of to 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 | IONPAYTEST01202103311759347262 |
referenceNo | ANS | 40 | Order Number | ord20210331170394 |
transDt | N | 8 | Transaction Date | 20210331 |
transTm | N | 6 | Transaction Time | 175934 |
amt | N | 12 | Amount | 10000 |
cancelReferenceNo (Optional For CC) | AN | 40 | Cancel Number | CancelNo20160525000-52104 |