V1 Cancel Transaction

6min

About Cancel Transaction
﻿
This 
﻿ uses to cancel 
﻿ registered 
﻿ that either, has and hasn't passed 
﻿ 
﻿ time. 
﻿
API Specifications - Cancel Order
﻿



API Endpoint
/nicepay/api/onePassAllCancel.do
Request Method application/x-www-form-urlencoded
﻿POST﻿
Description
Request Transaction Cancellation to 
﻿

Merchant Token
SHA256(iMid+tXid+amt+merchantKey)
﻿
Request Parameters - Cancel Order
Java
nicePay.setCancelMsg("Cancel Message");    
nicePay.setAmt("1000");    
nicePay.setFee("0");    
nicePay.setVat("0");    
nicePay.setNotaxAmt("0");    
nicePay.setReqServerIP("127.0.0.1");    
nicePay.setCancelUserId("");    
nicePay.setUserIP("127.0.0.1");    
nicePay.setCancelUserInfo("Customer cancel transaction");    
nicePay.setCancelRetryCnt("3");    
nicePay.setWorker("");    
// Cancel Mandatory Field    
nicePay.setTrxId("IONPAYTEST02201603091207051498");    
nicePay.setPayMethod("02");    
nicePay.setCancelType("1");    
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getAmt(), nicePay.getTrxId()));    
// Cancel request    
nicePay.cancel();    
// Cancel Response    
System.out.println("Response String : " + nicePay.getResponseString()); // JSON in String format    
nicePay.getHtResponse(); // JSON in HashTable<String, String> format    
String resultCd = nicePay.Get("resultCd");         
String resultMsg = nicePay.Get("resultMsg");         
String tXid= nicePay.Get("tXid ");         
String referenceNo= nicePay.Get("referenceNo");   
String transDt= nicePay.Get("transDt");   
String transTm= nicePay.Get("transTm");   
String description= nicePay.Get("description");   
String amount= nicePay.Get("amount");
nicePay.setCancelMsg("Cancel Message");    
nicePay.setAmt("1000");    
nicePay.setFee("0");    
nicePay.setVat("0");    
nicePay.setNotaxAmt("0");    
nicePay.setReqServerIP("127.0.0.1");    
nicePay.setCancelUserId("");    
nicePay.setUserIP("127.0.0.1");    
nicePay.setCancelUserInfo("Customer cancel transaction");    
nicePay.setCancelRetryCnt("3");    
nicePay.setWorker("");    
// Cancel Mandatory Field    
nicePay.setTrxId("IONPAYTEST02201603091207051498");    
nicePay.setPayMethod("02");    
nicePay.setCancelType("1");    
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getAmt(), nicePay.getTrxId()));    
// Cancel request    
nicePay.cancel();    
// Cancel Response    
System.out.println("Response String : " + nicePay.getResponseString()); // JSON in String format    
nicePay.getHtResponse(); // JSON in HashTable<String, String> format    
String resultCd = nicePay.Get("resultCd");         
String resultMsg = nicePay.Get("resultMsg");         
String tXid= nicePay.Get("tXid ");         
String referenceNo= nicePay.Get("referenceNo");   
String transDt= nicePay.Get("transDt");   
String transTm= nicePay.Get("transTm");   
String description= nicePay.Get("description");   
String amount= nicePay.Get("amount");
﻿

Parameter
Type
Size
Description
Example / Notes
iMid
﻿Required﻿
AN
10
﻿
﻿ ID
IONPAYTEST
merchantToken 
﻿Required﻿
AN
255
﻿
﻿ Token
c69fd0a2e36fb9d97fc8418f6b22699143a1177e570769dac2cf4d2008558946
tXid
Required﻿
AN
30
Transaction ID
IONPAYTEST02201603091207051498
payMethod
Required
N
2
﻿Payment Method﻿﻿
01
cancelType
Required
N
2
﻿Cancellation Type﻿﻿
1
amt
Required
N
12
Cancellation amount
1000
cancelMsg
AN
255
Cancellation message
Cancel Message
fee
N
12
Service Fee
0
vat
N
12
﻿
﻿ number
0
cancelServerIp
ANS
15
Server IP Address
127.0.0.1
cancelUserId
AN
30
User ID
﻿
cancelUserIp
ANS
15
User IP Address
127.0.0.1
cancelUserInfo
AN
100
User Information
﻿
﻿ cancel 
﻿﻿
cancelRetryCnt
N
2
Retry Count for Cancel
2
worker
N
10
Worker
﻿
﻿
Response Parameter - Cancel Order
JSON
{
    "acquirerData": {
        "rrn": "332510237487"
    },
    "tXid": "IONPAYTEST02201603091207051498",
    "referenceNo": "OrdNo20160525000-52104",
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "transDt": "20160303",
    "transTm": "135959",
    "description": "Payment of OrdNo20160525000-52104",
    "amount": "1000",
    "canceltXid": "IONPAYTEST02201603091207051499"
}
{
    "acquirerData": {
        "rrn": "332510237487"
    },
    "tXid": "IONPAYTEST02201603091207051498",
    "referenceNo": "OrdNo20160525000-52104",
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "transDt": "20160303",
    "transTm": "135959",
    "description": "Payment of OrdNo20160525000-52104",
    "amount": "1000",
    "canceltXid": "IONPAYTEST02201603091207051499"
}
﻿

Parameter
Type
Size
Description
Example / Notes
acquirerData
Array
20
A dynamic array consisting of a unique reference number RRN that is provided by 
﻿ 
﻿ing 
﻿ when a refund is 
﻿ed. This reference number can be used by 
﻿ 
﻿ to track 
﻿ 
﻿ of 
﻿ refund with 
﻿ 
﻿.
"acquirerData": {
    "rrn": "332510237487"
  }
tXid
AN
30
Transaction ID
IONPAYTEST02201603091207051498
referenceNo
ANS
40
﻿
﻿ Order Number
OrdNo20160525000-52104
resultCd 
N
4
﻿Result Code﻿﻿
0000
resultMsg
AN
255
﻿Result Message﻿﻿
SUCCESS
transDt
N
8
Transaction Date
20160303
transTm
N
6
Transaction Time
135959
description
AN
255
Description
﻿
﻿ of OrdNo20160525000-52104
amount
N
8
Amount
1000
canceltXid
AN
30
Cancel Transaction ID
IONPAYTEST02201603091207051499
cancelTrxSn
AN
32
Cancel Transaction Number
﻿
﻿

API Endpoint	/nicepay/api/onePassAllCancel.do
Request Method application/x-www-form-urlencoded	POST
Description	Request Transaction Cancellation to
Merchant Token	SHA256(iMid+tXid+amt+merchantKey)

Parameter	Type	Size	Description	Example / Notes
iMid Required	AN	10	ID	IONPAYTEST
merchantToken Required	AN	255	Token	c69fd0a2e36fb9d97fc8418f6b22699143a1177e570769dac2cf4d2008558946
tXid Required	AN	30	Transaction ID	IONPAYTEST02201603091207051498
payMethod Required	N	2	Payment Method	01
cancelType Required	N	2	Cancellation Type	1
amt Required	N	12	Cancellation amount	1000
cancelMsg	AN	255	Cancellation message	Cancel Message
fee	N	12	Service Fee	0
vat	N	12	number	0
cancelServerIp	ANS	15	Server IP Address	127.0.0.1
cancelUserId	AN	30	User ID
cancelUserIp	ANS	15	User IP Address	127.0.0.1
cancelUserInfo	AN	100	User Information	cancel
cancelRetryCnt	N	2	Retry Count for Cancel	2
worker	N	10	Worker

Parameter	Type	Size	Description	Example / Notes
acquirerData	Array	20	A dynamic array consisting of a unique reference number RRN that is provided by ing when a refund is ed. This reference number can be used by to track of refund with .	"acquirerData": { "rrn": "332510237487" }
tXid	AN	30	Transaction ID	IONPAYTEST02201603091207051498
referenceNo	ANS	40	Order Number	OrdNo20160525000-52104
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message	SUCCESS
transDt	N	8	Transaction Date	20160303
transTm	N	6	Transaction Time	135959
description	AN	255	Description	of OrdNo20160525000-52104
amount	N	8	Amount	1000
canceltXid	AN	30	Cancel Transaction ID	IONPAYTEST02201603091207051499
cancelTrxSn	AN	32	Cancel Transaction Number

Updated 08 Oct 2024

Did this page help you?

V1 Check Transaction Status

V1 Notification

V1 Cancel Transaction

About Cancel Transaction

API Specifications - Cancel Order

Request Parameters - Cancel Order

Response Parameter - Cancel Order

Welcome to NICEPAY DOCS