Cancel - API Convenience Store

14min

About API Convenience Store Cancel
﻿
This ﻿ uses by ﻿s to integrate ﻿ cancel ﻿ for ﻿'s ﻿ used by ﻿ ﻿. 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 ﻿ ﻿ number issue can't be used anymore.
﻿﻿ number can only canceled  before being paid before ﻿ ﻿ ﻿ is executed. 
If ﻿ ﻿ has ﻿ed with ﻿ ﻿ ﻿, ﻿ paid bill can't be canceled or refunded to ﻿ ﻿ through ﻿.
﻿
API Convenience Store Cancel
﻿
The ﻿ Cancel ﻿ uses for ﻿ cancel ﻿ for ﻿s through ﻿.
API End Point
/nicepay/direct/v2/cancel
Request Method
﻿POST﻿
Header
Content-Type: application/json
Merchant Token
SHA256(timeStamp+iMid+tXid+amt+merchantKey)
Request Format
application/json
﻿
Payment Methods Available for Cancel
﻿
Code              PayMethod
﻿
01               ﻿
﻿
02               ﻿﻿
﻿
03               Convenience Store﻿
﻿
04               ﻿ 
﻿
05               ﻿﻿
﻿
06               ﻿﻿
﻿
08               ﻿ 
﻿
09               ﻿ 
﻿
﻿
Request Parameters for Convenience Store Cancel
﻿
The following is a list of ﻿s for activating ﻿ cancel ﻿ for ﻿ ﻿ ﻿. These ﻿s use via ﻿ ﻿ ﻿ platform.
Parameter
Type
Size
Description
Example / Notes
timeStamp
 Required﻿
N
14
﻿﻿ Request Timestamp 
﻿
20221212101278
tXid
 Required﻿
AN
30
Transaction ID
﻿

IONPAYTEST03202212121030529316
iMid
 Required﻿
AN
10
﻿﻿ ID
﻿

IONPAYTEST
payMethod
 Required﻿
N
2
﻿Payment Method Code﻿ 

03
cancelType
 Required﻿
N
2
﻿Cancel Type Code﻿ 
﻿

1
cancelMsg
AN
255
Cancel Message
Request Cancel
merchantToken
 Required﻿
AN
255
﻿﻿ Token 
﻿
﻿
49974dde3c4a311030bd2095431443ce3689d79c90caaa88f4186050abb77cf9
amt
 Required﻿
N
12
﻿﻿ Amount 
﻿

10000
preauthToken
AN
100
Pre-Auth Token
-
﻿
Response Parameters for Convenience Store Cancel
﻿
Following are ﻿ response ﻿s from ﻿ results of ﻿ request ﻿s for ﻿ ﻿ of ﻿ ﻿ ancel:
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
IONPAYTEST03202212121030529316
referenceNo
ANS
40
﻿﻿ Order Number
815123412341
transDt
N
8
Transaction Date
20221212
transTm
N
6
Transaction Time
103052
description
AN
255
Description
test cancel
amt
N
12
Amount
10000
﻿
Response Parameter for Convenience Store Cancel 
﻿
JSON Request
JSON Response
Java Request
//Cancel Registration//
nicePay.setTimeStamp("20221208091279");
nicePay.setiMid("IONPAYTEST");
nicePay.setAmt("5");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getMerchantToken());
nicePay.settXid("IONPAYTEST08202212080951090538");
nicePay.setPayMethod("03");
nicePay.setCancelType("1");
nicePay.setCancelMsg("Request Cancel");



// Request Cancel
nicePay.cancel();

// Response String //
System.out.println("Final Response String : " + nicePay.getResponseString());

String resultCd = nicePay.Get("resultCd");
String resultMsg = nicePay.Get("resultMsg");
String tXid = nicePay.Get("tXid");
String referenceNo = nicePay.Get("referenceNo");
String amt = nicePay.Get("amt");
String cancelReferenceNo = nicePay.Get("cancelReferenceNo");
//Cancel Registration//
nicePay.setTimeStamp("20221208091279");
nicePay.setiMid("IONPAYTEST");
nicePay.setAmt("5");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getMerchantToken());
nicePay.settXid("IONPAYTEST08202212080951090538");
nicePay.setPayMethod("03");
nicePay.setCancelType("1");
nicePay.setCancelMsg("Request Cancel");



// Request Cancel
nicePay.cancel();

// Response String //
System.out.println("Final Response String : " + nicePay.getResponseString());

String resultCd = nicePay.Get("resultCd");
String resultMsg = nicePay.Get("resultMsg");
String tXid = nicePay.Get("tXid");
String referenceNo = nicePay.Get("referenceNo");
String amt = nicePay.Get("amt");
String cancelReferenceNo = nicePay.Get("cancelReferenceNo");
﻿

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

Parameter	Type	Size	Description	Example / Notes
timeStamp Required	N	14	Request Timestamp	20221212101278
tXid Required	AN	30	Transaction ID	IONPAYTEST03202212121030529316
iMid Required	AN	10	ID	IONPAYTEST
payMethod Required	N	2	Payment Method Code	03
cancelType Required	N	2	Cancel Type Code	1
cancelMsg	AN	255	Cancel Message	Request Cancel
merchantToken Required	AN	255	Token	49974dde3c4a311030bd2095431443ce3689d79c90caaa88f4186050abb77cf9
amt Required	N	12	Amount	10000
preauthToken	AN	100	Pre-Auth Token	-

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	IONPAYTEST03202212121030529316
referenceNo	ANS	40	Order Number	815123412341
transDt	N	8	Transaction Date	20221212
transTm	N	6	Transaction Time	103052
description	AN	255	Description	test cancel
amt	N	12	Amount	10000

Notification - API Convenience Store

API Direct Debit

Cancel - API Convenience Store

About API Convenience Store Cancel

API Convenience Store Cancel

Payment Methods Available for Cancel

Request Parameters for Convenience Store Cancel

Response Parameters for Convenience Store Cancel

Response Parameter for Convenience Store Cancel

Welcome to NICEPAY DOCS