Skip to main content

Payment Cancellation

This API is used to cancel an approved payment. You can request a cancellation using the information issued during the original transaction (either the VAN Transaction Number or the Merchant Transaction Number).

Important Precautions
  • Timeout Handling: If you do not receive a response due to a Read Timeout or Network Error, the cancellation may have actually been processed. In this case, you MUST verify the transaction status via the Net-Cancel API.

Request​

Request URL
POST https://{API Domain}/smpy/kiccpay/reqCancel
Content-type: application/json; charset=utf-8

Parameters​

Field NameTypeLengthRequiredDescription
tidString10Byte✅KICC Terminal ID
svcIdString10Byte✅KICC Simple Payment Service ID
bizrNoString10Byte✅Merchant Business Registration Number
mercTrxNoString40Byte✅Merchant Transaction Number for this cancellation request (20Byte recommended)
wccString1Byte✅Cancellation Key Type
T: VAN Transaction Number
G: Merchant Transaction Number
cndTrxNoString20Byte✅Transaction Number for Cancellation
If wcc="T": Original vanTrxNo
If wcc="G": Original mercTrxNo
alotMonthString2Byte✅Installment Period (Default: "00" - Lump-sum)
trxAmtNumber✅Total Payment Amount
vatAmtNumber✅VAT
svcAmtNumber✅Service Charge
tranDtString8Byte✅Merchant Transmission Date (yyyyMMdd)
tranTmString6Byte✅Merchant Transmission Time (HH24MISS)
orgAprvDtString8Byte✅Original Approval Date (yyyyMMdd)
orgAprvNoString10Byte✅Original Approval Number
Request Example
{
"tid": "T123456789",
"svcId": "SVC_SIMPLE",
"bizrNo": "1234567890",
"mercTrxNo": "CANCEL_20231225_0001",
"wcc": "G",
"cndTrxNo": "ORD_20231225_0001",
"alotMonth": "00",
"trxAmt": 10000,
"vatAmt": 909,
"svcAmt": 0,
"tranDt": "20231226",
"tranTm": "100000",
"orgAprvDt": "20231225",
"orgAprvNo": "12345678"
}

Response​

Parameters​

Field NameTypeLengthRequiredDescription
respCdString4Byte✅Result Code (Success: “0000”)
respMsgString128Byte✅Result Message
tidString10Byte✅KICC Terminal ID
svcIdString10Byte✅KICC Simple Payment Service ID
bizrNoString10Byte✅Merchant Business Registration Number
mercTrxNoString20Byte✅Merchant Transaction Number
trxDtString8Byte✅VAN Processing Request Date
trxTmString6Byte✅VAN Processing Request Time
issFmCdString4Byte✅Issuer Code (Refer to Card Codes)
issFmNmString20Byte✅Issuer Name
purchFmCdString4Byte✅Acquirer Code (Refer to Card Codes)
purchFmNmString20Byte✅Acquirer Name
joShopNoString15Byte✅Card Issuer Merchant Number
cndDtString8Byte✅Card Issuer Cancellation Date
cndTmString6Byte✅Card Issuer Cancellation Time
aprvNoString10Byte✅Credit Approval Number
vanTrxNoString12Byte✅VAN Unique Transaction Number
cardConfirmNoString40Byte✅Masked Card Number
Response Example
{
"respCd": "0000",
"respMsg": "Cancellation Success",
"tid": "T123456789",
"svcId": "SVC_SIMPLE",
"bizrNo": "1234567890",
"mercTrxNo": "CANCEL_20231225_0001",
"trxDt": "20231226",
"trxTm": "100001",
"issFmCd": "06",
"issFmNm": "KB Kookmin Card",
"purchFmCd": "06",
"purchFmNm": "KB Kookmin Card",
"joShopNo": "1234567890",
"cndDt": "20231226",
"cndTm": "100002",
"aprvNo": "12345678",
"vanTrxNo": "V12345678902",
"cardConfirmNo": "1234-56**-****-1234"
}