Cancel - API GPN

13min

About API GPN Cancel
﻿
This ﻿ uses to cancel ﻿ paid ﻿. If ﻿ ﻿ cancels before ﻿ settlement ﻿ is done, then that ﻿ will consider void, and that fund ﻿ will return to Your ﻿.
﻿
API GPN Cancel
﻿
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)
﻿
Payment Methods Available for Cancel
﻿
Code              PayMethod
﻿
01               ﻿
﻿
02               ﻿ 
﻿
03               ﻿ 
﻿
04               ﻿ 
﻿
05               ﻿ 
﻿
06               ﻿ 
﻿
08               ﻿ 
﻿
09               GPN﻿
﻿
﻿
Request Parameters for GPN Cancel
﻿
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
﻿
﻿
Response Parameter for GPN Cancel
﻿
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
﻿
Sample JSON for GPN Cancel
﻿
JSON Request
JSON Response
Java Request
{
    "timeStamp":"20180123100505",
    "tXid":"IONPAYTEST01202103311759347262",
    "iMid":"IONPAYTEST",
    "payMethod":"09",
    "cancelType":"1",
    "cancelMsg":"Request Cancel",
    "merchantToken":"66141d60572e570045c4f3e9965f3452d511496841981e8a2af6a24a7038a119",
    "preauthToken":"",
    "amt":"10000",
    "cancelServerIp":"127.0.0.1",
    "cancelUserId":"admin",
    "cancelUserIp":"127.0.0.1",
    "cancelUserInfo":"Test Cancel",
    "cancelRetryCnt":"3",
    "referenceNo": "CancelNo20160525000-52104",
    "worker":""
}
{
    "timeStamp":"20180123100505",
    "tXid":"IONPAYTEST01202103311759347262",
    "iMid":"IONPAYTEST",
    "payMethod":"09",
    "cancelType":"1",
    "cancelMsg":"Request Cancel",
    "merchantToken":"66141d60572e570045c4f3e9965f3452d511496841981e8a2af6a24a7038a119",
    "preauthToken":"",
    "amt":"10000",
    "cancelServerIp":"127.0.0.1",
    "cancelUserId":"admin",
    "cancelUserIp":"127.0.0.1",
    "cancelUserInfo":"Test Cancel",
    "cancelRetryCnt":"3",
    "referenceNo": "CancelNo20160525000-52104",
    "worker":""
}
﻿

API Endpoint	/nicepay/direct/v2/cancel
Request Method	POST
Header	Content-Type: application/json
Merchant Token	SHA256(timeStamp+iMid+tXid+amt+merchantKey)

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

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

Notification - API GPN

API QRIS

Cancel - API GPN

About API GPN Cancel

API GPN Cancel

Payment Methods Available for Cancel

Request Parameters for GPN Cancel

Response Parameter for GPN Cancel

Sample JSON for GPN Cancel

Welcome to NICEPAY DOCS