Cancel - API Checkout

7min

Tentang API Checkout Cancel 
﻿
﻿ ini digunakan untuk membatalkan   akan berjalan. Khusus untuk VA,  hanya dapat dibatalkan sebelum melakukan  . Setelah  dibatalkan,  harus kembali melakukan pendaftaran dari awal melalui Registration - API Checkout﻿.
﻿
API Checkout Cancel 
﻿
API URL
/nicepay/direct/v2/cancel
Request Method 
POST
Header
﻿Content-Type: application/json﻿
Merchant Token
SHA256 (timestamp+ iMid+ tXid+ amt+ merchantKey)
﻿
Request Parameters
﻿
Parameter
Tipe
Ukuran
Deskripsi
Contoh / Catatan
timeStamp
﻿Required﻿
N
14
﻿ Request Timestamp
20221219111294
tXid
﻿Required﻿
AN
30
Transaction ID
﻿
NORMALTEST00202212191104443483
iMid
﻿Required﻿
AN
10
﻿ ID
﻿
NORMALTEST
payMethod
﻿Required﻿
N
2
﻿Payment Method Code﻿﻿
02
cancelType
﻿Required﻿
N
2
﻿Cancel Type Code﻿﻿
﻿
1
merchantToken
﻿Required﻿
AN
255
﻿ Token
﻿
63d44f80942cc915f6d736995797470ac2918a9f88b6fb762608541145e65bd8
amt
﻿Required﻿
N
12
﻿ Amount
﻿
10000
cancelMsg
﻿Required﻿
AN
255
Cancel Message
Request Cancel
preauthToken
AN
100
Pre-Auth Token
d4ef98b26f917a697691807cf…
referenceNo
﻿Optional For CC﻿
ANS
40
﻿ Cancel Number 
CancelNo20160525000-52104
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 Parameters
﻿
Parameter
Tipe
Ukuran
Deskripsi
Contoh / Catatan
resultCd
N
4
﻿Result Code﻿ 
0000
resultMsg
AN
255
Result Message: Error Code﻿ 
SUCCESS
tXid
AN
30
Transaction ID
NORMALTEST00202212191104443483
﻿
When Success
referenceNo
ANS
40
﻿ Order Number
ORDER20221012080918
﻿
When Success
transDt
N
8
Transaction Date
20221219
﻿
When Success
transTm
N
6
Transaction Time
110444
﻿
When Success
amt
N
12
Amount
10000
﻿
When Success
description
AN
255
Description
﻿
canceltXid
AN
30
Cancel Transaction ID
﻿
cancelTrxSn
AN
32
Cancel Transaction Number
﻿
cancelReferenceNo
﻿Optional For CC﻿
AN
40
﻿ Cancel Number
﻿
﻿
Sample JSON for API Checkout Cancel
﻿
JSON Request
JSON Response
Java Request
{
	"timeStamp":"20221219111294",
	"tXid":"NORMALTEST00202212191104443483",
	"iMid":"NORMALTEST",
	"payMethod":"02",
	"cancelType":"1",
	"cancelMsg":"Request Cancel",
	"merchantToken":"63d44f80942cc915f6d736995797470ac2918a9f88b6fb762608541145e65bd8",
	"amt":"10000"
}
{
	"timeStamp":"20221219111294",
	"tXid":"NORMALTEST00202212191104443483",
	"iMid":"NORMALTEST",
	"payMethod":"02",
	"cancelType":"1",
	"cancelMsg":"Request Cancel",
	"merchantToken":"63d44f80942cc915f6d736995797470ac2918a9f88b6fb762608541145e65bd8",
	"amt":"10000"
}
﻿
﻿

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

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
timeStamp Required	N	14	Request Timestamp	20221219111294
tXid Required	AN	30	Transaction ID	NORMALTEST00202212191104443483
iMid Required	AN	10	ID	NORMALTEST
payMethod Required	N	2	Payment Method Code	02
cancelType Required	N	2	Cancel Type Code	1
merchantToken Required	AN	255	Token	63d44f80942cc915f6d736995797470ac2918a9f88b6fb762608541145e65bd8
amt Required	N	12	Amount	10000
cancelMsg Required	AN	255	Cancel Message	Request Cancel
preauthToken	AN	100	Pre-Auth Token	d4ef98b26f917a697691807cf…
referenceNo Optional For CC	ANS	40	Cancel Number	CancelNo20160525000-52104
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	Tipe	Ukuran	Deskripsi	Contoh / Catatan
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message: Error Code	SUCCESS
tXid	AN	30	Transaction ID	NORMALTEST00202212191104443483 When Success
referenceNo	ANS	40	Order Number	ORDER20221012080918 When Success
transDt	N	8	Transaction Date	20221219 When Success
transTm	N	6	Transaction Time	110444 When Success
amt	N	12	Amount	10000 When Success
description	AN	255	Description
canceltXid	AN	30	Cancel Transaction ID
cancelTrxSn	AN	32	Cancel Transaction Number
cancelReferenceNo Optional For CC	AN	40	Cancel Number

Updated 23 Aug 2024

Did this page help you?

Notification - API Checkout

Payment API

Cancel - API Checkout

Tentang API Checkout Cancel

API Checkout Cancel

Request Parameters

Response Parameters

Sample JSON for API Checkout Cancel

Selamat Datang di NICEPAY DOCS