Cancel - API Credit Card

8min

About API Credit Card Cancel
﻿
This 
﻿ uses by 
﻿ to cancel 
﻿ paid 
﻿.
If You cancel before 
﻿ settlement 
﻿ is complete, then 
﻿ 
﻿ is considered Void and 
﻿ 
﻿ funds will be returned to your 
﻿. However, cancellations after 
﻿ settlement 
﻿ is complete are included in 
﻿ Refund category
﻿
﻿
﻿ visit Credit Card Transaction Settlement﻿ 
﻿ to find out more about 
﻿ terms Void or Refund.
﻿
API Credit Card Cancel
﻿
The 
﻿ Cancel 
﻿ uses to cancel 
﻿ 
﻿ of 
﻿s via 
﻿.
API End Point
/nicepay/direct/v2/cancel
Request Method
﻿POST﻿
Header
Content-Type: application/json
Merchant Token
SHA256(timeStamp+iMid+tXid+amt+merchantKey)
﻿
Request Parameters for Credit Card Cancel
﻿
The following is a list of request 
﻿s in 
﻿ Cancel 
﻿ 
﻿ to 
﻿ cancel 
﻿s for 
﻿ 
﻿s. This 
﻿s uses through 
﻿ 
﻿ 
﻿ platform.
Parameter
Type
Size
Description
Example / Notes
timeStamp
﻿Required﻿
N
14
﻿
﻿ Request Timestamp 
﻿
20221214111239
tXid
﻿Required﻿
AN
30
Transaction ID
﻿

IONPAYTEST01202212141146401456
iMid
﻿Required﻿
AN
10
﻿
﻿ ID
﻿

IONPAYTEST
payMethod
﻿Required﻿
N
2
﻿Payment Method Code﻿﻿

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

2
merchantToken
﻿Required﻿
AN
255
﻿
﻿ token 
﻿
﻿
ff139e49606387091cd9baeadff3161aff6afd9406e1f481e0fdb8b46d1ae5ae
referenceNo
ANS
40
Reference Number
ordNo20221214111208
amt
﻿Required﻿
N
12
﻿
﻿ Amount 
﻿

1000
cancelMsg
AN
255
Cancel Message
Cancellation Of Transaction 
﻿
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
5
worker
AN
10
Worker
Worker
﻿
Response Parameter for Credit Card Cancel
﻿
The following is a list of Response Parameter or 
﻿ result from 
﻿ Request Parameter for 
﻿ cancel handling:
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
IONPAYTEST01202212141146401456
referenceNo
ANS
40
﻿
﻿ Order Number
ordNo20221214111208
transDt
N
8
Transaction Date
20221214
transTm
N
6
Transaction Time
114640
amt
N
12
Amount
5000
cancelReferenceNo
﻿Optional For CC﻿
AN
40
﻿
﻿ Cancel Number
ordNo20221214111208
acquirerData
﻿Only For CC﻿
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":"332608321717"
  }
﻿
Sample JSON for Credit Card Cancel
﻿
JSON Request
JSON Response
Java Request
{
    "tXid": "IONPAYTEST01202212141146401456",
    "referenceNo": "ordNo20221214111208",
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "transDt": "20221214",
    "transTm": "114640",
    "amt": "5000",
    "cancelReferenceNo": "ordNo20221214111208",
}
{
    "tXid": "IONPAYTEST01202212141146401456",
    "referenceNo": "ordNo20221214111208",
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "transDt": "20221214",
    "transTm": "114640",
    "amt": "5000",
    "cancelReferenceNo": "ordNo20221214111208",
}
﻿
﻿

API End Point	/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	20221214111239
tXid Required	AN	30	Transaction ID	IONPAYTEST01202212141146401456
iMid Required	AN	10	ID	IONPAYTEST
payMethod Required	N	2	Payment Method Code	01
cancelType Required	N	2	Cancel Type Code	2
merchantToken Required	AN	255	token	ff139e49606387091cd9baeadff3161aff6afd9406e1f481e0fdb8b46d1ae5ae
referenceNo	ANS	40	Reference Number	ordNo20221214111208
amt Required	N	12	Amount	1000
cancelMsg	AN	255	Cancel Message	Cancellation Of Transaction
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	5
worker	AN	10	Worker	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	IONPAYTEST01202212141146401456
referenceNo	ANS	40	Order Number	ordNo20221214111208
transDt	N	8	Transaction Date	20221214
transTm	N	6	Transaction Time	114640
amt	N	12	Amount	5000
cancelReferenceNo Optional For CC	AN	40	Cancel Number	ordNo20221214111208
acquirerData Only For CC	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":"332608321717" }

Updated 03 Sep 2024

Did this page help you?

Pre-Auth & Capture - Payment API Credit Card

Status Inquiry - API Credit Card

Cancel - API Credit Card

About API Credit Card Cancel

API Credit Card Cancel

Request Parameters for Credit Card Cancel

Response Parameter for Credit Card Cancel

Sample JSON for Credit Card Cancel

Welcome to NICEPAY DOCS