Cancel - API Direct Debit

13min

About API Direct Debit Cancel
﻿
This 
﻿ uses by 
﻿s to integrate 
﻿ cancel 
﻿ for 
﻿ 
﻿.
﻿
API Direct Debit Cancel
﻿
The 
﻿ Cancel 
﻿ is used for 
﻿ cancel 
﻿ for 
﻿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 Format
application/json
﻿
Payment Methods Available for Cancel
﻿
Code              PayMethod
﻿
01               
﻿
﻿
02               
﻿ 
﻿
03               Convenience Store﻿
﻿
04               
﻿﻿
﻿
05               
﻿ 
﻿
06               
﻿ 
﻿
08               
﻿ 
﻿
09               
﻿ 
﻿
﻿
Request Parameters for Direct Debit Cancel
﻿
The following is a list of 
﻿s to activate 
﻿ cancel 
﻿ for 
﻿ 
﻿ 
﻿. These 
﻿s are used via 
﻿ 
﻿ 
﻿ platform.
Parameter
Type
Size
Description
Notes / Example
timeStamp
 Required﻿
N
14
﻿
﻿ Request Timestamp 
﻿
20230515141929
tXid
 Required﻿
AN
30
Transaction ID
﻿

TNICECP04104202305151417238166
iMid
 Required﻿
AN
10
﻿
﻿ ID
﻿

TNICECP041
payMethod
 Required﻿
N
2
﻿Payment Method Code﻿ 

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

1
cancelMsg
AN
255
Cancel Message
Request Cancel
merchantToken
 Required﻿
AN
255
﻿
﻿ Token 
﻿
﻿
89fa33ec4c17f5048e69c404b42d07005f1dd6ab64354c583d04670cf9690ed8
amt
 Required﻿
N
12
﻿
﻿ Amount 
﻿

10000
preauthToken
AN
100
Pre-Auth Token
﻿
cancelUserId
AN
30
User ID
admin
﻿
Response Parameters for Direct Debit Cancel
﻿
Following are 
﻿ response 
﻿s from 
﻿ results of 
﻿ request 
﻿s for 
﻿ of 
﻿ 
﻿ to cancel:
Parameter
Type
Szie
Description
Example / Notes
resultCd
N
4
﻿Result Code﻿ 
﻿
0000
resultMsg
AN
255
Result Message: Error Code﻿
 
SUCCESS
tXid
AN
30
Transaction ID
TNICECP04104202305151417238166
referenceNo
ANS
40
﻿
﻿ Order Number
20230515141702
transDt
N
8
Transaction Date
20230515
transTm
N
6
Transaction Time
141723
amt
N
12
Amount
2000
cancelReferenceNo
﻿(Optional For CC)﻿
ANS
40
﻿
﻿ Cancel Number
CancelNo20230515141702
﻿
Sample Parameter for Direct Debit Cancel
﻿
JSON Request
JSON Response
Java Request
{
    "timeStamp":"20230515141929",
    "tXid":"TNICECP04104202305151417238166",
    "iMid":"TNICECP041",
    "payMethod":"04",
    "cancelType":"1",
    "cancelMsg":"Request Cancel",
    "merchantToken":"89fa33ec4c17f5048e69c404b42d07005f1dd6ab64354c583d04670cf9690ed8",
    "preauthToken":"",
    "amt":"10000",
    "cancalUserId":"admin"
}
{
    "timeStamp":"20230515141929",
    "tXid":"TNICECP04104202305151417238166",
    "iMid":"TNICECP041",
    "payMethod":"04",
    "cancelType":"1",
    "cancelMsg":"Request Cancel",
    "merchantToken":"89fa33ec4c17f5048e69c404b42d07005f1dd6ab64354c583d04670cf9690ed8",
    "preauthToken":"",
    "amt":"10000",
    "cancalUserId":"admin"
}
﻿
﻿

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	Notes / Example
timeStamp Required	N	14	Request Timestamp	20230515141929
tXid Required	AN	30	Transaction ID	TNICECP04104202305151417238166
iMid Required	AN	10	ID	TNICECP041
payMethod Required	N	2	Payment Method Code	04
cancelType Required	N	2	Cancel Type Code	1
cancelMsg	AN	255	Cancel Message	Request Cancel
merchantToken Required	AN	255	Token	89fa33ec4c17f5048e69c404b42d07005f1dd6ab64354c583d04670cf9690ed8
amt Required	N	12	Amount	10000
preauthToken	AN	100	Pre-Auth Token
cancelUserId	AN	30	User ID	admin

Parameter	Type	Szie	Description	Example / Notes
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message: Error Code	SUCCESS
tXid	AN	30	Transaction ID	TNICECP04104202305151417238166
referenceNo	ANS	40	Order Number	20230515141702
transDt	N	8	Transaction Date	20230515
transTm	N	6	Transaction Time	141723
amt	N	12	Amount	2000
cancelReferenceNo (Optional For CC)	ANS	40	Cancel Number	CancelNo20230515141702

Updated 05 Sep 2024

Did this page help you?

Notification - API Direct Debit

API E-Wallet

Cancel - API Direct Debit

About API Direct Debit Cancel

API Direct Debit Cancel

Payment Methods Available for Cancel

Request Parameters for Direct Debit Cancel

Response Parameters for Direct Debit Cancel

Sample Parameter for Direct Debit Cancel

Welcome to NICEPAY DOCS