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 Name	Type	Length	Required	Description
tid	String	10Byte	✅	KICC Terminal ID
svcId	String	10Byte	✅	KICC Simple Payment Service ID
bizrNo	String	10Byte	✅	Merchant Business Registration Number
mercTrxNo	String	40Byte	✅	Merchant Transaction Number for this cancellation request (20Byte recommended)
wcc	String	1Byte	✅	Cancellation Key Type T: VAN Transaction Number G: Merchant Transaction Number
cndTrxNo	String	20Byte	✅	Transaction Number for Cancellation If wcc="T": Original vanTrxNo If wcc="G": Original mercTrxNo
alotMonth	String	2Byte	✅	Installment Period (Default: "00" - Lump-sum)
trxAmt	Number		✅	Total Payment Amount
vatAmt	Number		✅	VAT
svcAmt	Number		✅	Service Charge
tranDt	String	8Byte	✅	Merchant Transmission Date (yyyyMMdd)
tranTm	String	6Byte	✅	Merchant Transmission Time (HH24MISS)
orgAprvDt	String	8Byte	✅	Original Approval Date (yyyyMMdd)
orgAprvNo	String	10Byte	✅	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 Name	Type	Length	Required	Description
respCd	String	4Byte	✅	Result Code (Success: “0000”)
respMsg	String	128Byte	✅	Result Message
tid	String	10Byte	✅	KICC Terminal ID
svcId	String	10Byte	✅	KICC Simple Payment Service ID
bizrNo	String	10Byte	✅	Merchant Business Registration Number
mercTrxNo	String	20Byte	✅	Merchant Transaction Number
trxDt	String	8Byte	✅	VAN Processing Request Date
trxTm	String	6Byte	✅	VAN Processing Request Time
issFmCd	String	4Byte	✅	Issuer Code (Refer to Card Codes)
issFmNm	String	20Byte	✅	Issuer Name
purchFmCd	String	4Byte	✅	Acquirer Code (Refer to Card Codes)
purchFmNm	String	20Byte	✅	Acquirer Name
joShopNo	String	15Byte	✅	Card Issuer Merchant Number
cndDt	String	8Byte	✅	Card Issuer Cancellation Date
cndTm	String	6Byte	✅	Card Issuer Cancellation Time
aprvNo	String	10Byte	✅	Credit Approval Number
vanTrxNo	String	12Byte	✅	VAN Unique Transaction Number
cardConfirmNo	String	40Byte	✅	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"
}