Skip to main content

Payment Cancellation (VAN)

This API is used to perform a full cancellation of a completed transaction.

Request​

Request URL
POST https://{API Domain}/appcardpay/v1/cancel.do
Content-type: application/json; charset=euc-kr
Note

Supports API Idempotency (See API Idempotency)

Critical: Timeout Handling
  • The final cancellation process may take time; please set your client timeout to 30 seconds.
  • If you do not receive a response due to a timeout or network error, you MUST check the status via Query Transaction Status using the original transaction ID and then proceed with the cancellation to avoid duplicate requests.

Parameters​

Field NameTypeLengthRequiredDescription
vanTidString8Byte✅VAN Terminal ID
shopTransactionIdString60Byte✅Merchant Transaction ID (API Idempotency Key)
controlNoString20Byte✅Original Approval KICC Transaction Sequence Number
approvalReqDateString8Byte✅Original Approval Request Date (yyyyMMdd)
cancelReqDateString8Byte✅Cancel Request Date (yyyyMMdd). Must be set to the current date.
Request Example
{  
"vanTid": "T5102001",
"shopTransactionId": "{API Idempotency Key}",
"controlNo": "{Original Approval KICC Transaction Sequence Number}",
"approvalReqDate": "{Original Request Date}",
"cancelReqDate": "{Current Date}"
}

Response​

Parameters​

Field NameTypeLengthRequiredDescription
resCdString4Byte✅Result Code (Success: “0000”)
resMsgString1000Byte✅Result Message
shopTransactionIdString60Byte✅Returns the value sent in the cancellation request
vanTidString8ByteVAN Terminal ID
cancelControlNoString20ByteKICC Transaction Sequence Number for the cancellation
transactionDateString14ByteTransaction Date (yyyyMMddHHmmss)
vanSerialString20ByteVAN Cancellation Transaction Serial Number
amountNumberTotal Canceled Amount
Response Example
{
"resCd": "0000",
"resMsg": "Cancel Success",
"vanTid": "{VAN Terminal ID}",
"shopTransactionId": "{API Idempotency Key}",
"cancelControlNo": "{Cancel Transaction ID}",
"transactionDate": "20210326090200",
"vanSerial": "{VAN Cancel Serial}",
"amount": 0
}