Cancel - API Direct Debit

13 min

About API Direct Debit Cancel

This API uses by Merchants to integrate the cancel system for Direct Debit payment method.

API Direct Debit Cancel

The Direct Debit Cancel API is used for the cancel system for payments via Direct Debit.

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 Credit Card

02 Virtual Account

03 Convenience Store

04 Direct Debit

05 E-Wallet

06 Paylater

08 QRIS

09 GPN

Request Parameters for Direct Debit Cancel

The following is a list of parameters to activate the cancel system for the Direct Debit payment method. These parameters are used via the API testing platform.

Parameter	Type	Size	Description	Notes / Example
timeStamp Required	N	14	API Request Timestamp	20230515141929
tXid Required	AN	30	Transaction ID	TNICECP04104202305151417238166
iMid Required	AN	10	Merchant 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	Merchant Token	89fa33ec4c17f5048e69c404b42d07005f1dd6ab64354c583d04670cf9690ed8
amt Required	N	12	Payment Amount	10000
preauthToken	AN	100	Pre-Auth Token
cancelUserId	AN	30	User ID	admin

Response Parameters for Direct Debit Cancel

Following are the response parameters from the results of the request parameters for integration of the Direct Debit 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	Merchant 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	Merchant Cancel Number	CancelNo20230515141702

Sample Parameter for Direct Debit Cancel

{
    "timeStamp":"20230515141929",
    "tXid":"TNICECP04104202305151417238166",
    "iMid":"TNICECP041",
    "payMethod":"04",
    "cancelType":"1",
    "cancelMsg":"Request Cancel",
    "merchantToken":"89fa33ec4c17f5048e69c404b42d07005f1dd6ab64354c583d04670cf9690ed8",
    "preauthToken":"",
    "amt":"10000",
    "cancalUserId":"admin"
}