Cancel - API Checkout

9 min

Tentang API Checkout Cancel

API ini digunakan untuk membatalkan transaksi yang akan berjalan. Khusus untuk VA, transaksi hanya dapat dibatalkan sebelum melakukan proses pembayaran. Setelah transaksi dibatalkan, Pelanggan 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	API Request Timestamp	20221219111294
tXid Required	AN	30	Transaction ID	NORMALTEST00202212191104443483
iMid Required	AN	10	Merchant ID	NORMALTEST
payMethod Required	N	2	Payment Method Code	02
cancelType Required	N	2	Cancel Type Code	1
merchantToken Required	AN	255	Merchant Token	63d44f80942cc915f6d736995797470ac2918a9f88b6fb762608541145e65bd8
amt Required	N	12	Payment Amount	10000
cancelMsg Required	AN	255	Cancel Message	Request Cancel
preauthToken	AN	100	Pre-Auth Token	d4ef98b26f917a697691807cf…
referenceNo Optional For CC	ANS	40	Merchant 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	Merchant 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	Merchant Cancel Number

Sample Parameter for Cancel - API Checkout

Request Parameter

$config = Nicepay::builder()
    ->setIsProduction(false)
    ->setIsCloudServer(false)
    ->build();

$timestamp = "20251111011147";
$txId = "IONPAYTEST02202511110137007677";
$amount = "10000";

$requestBody = Cancel::builder()
    ->setTimeStamp($timestamp)
    ->setIMid($this->iMid)
    ->setTXid($txId)
    ->setMerchantToken($timestamp, $this->iMid, $txId, $amount, $this->merchantKey)
    ->setPayMethod("02")
    ->setCancelType("1")
    ->setAmt($this->amount)
    ->setCancelMsg("Cancel Testing Transaction")
    ->setCancelUserId("")
    ->setCancelUserIp("127.0.0.1")
    ->setCancelServerIp("127.0.0.1")
    ->setCancelUserInfo("")
    ->setCancelRetryCnt("")
    ->setWorker("")
    ->build();

try {
    $v2VaService = new V2VAService($config);
    $response = $v2VaService->cancel($requestBody);
}

Response Parameter

{
    "tXid": "IONPAYTEST02202511110137007677",
    "referenceNo": "ordNo20251111011183",
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "transDt": "20251111",
    "transTm": "013700",
    "description": "TESTING TRANSACTION",
    "amt": "10000"
}