Check Cancellation Status

This API is used to verify the cancellation status if you do not receive a cancellation completion notification within a certain timeframe.

Request

Request URL

POST https://{API Domain}/api/trades/wechatpay/find
Content-type: application/json; charset=utf-8

Note

Supports API Idempotency (See API Idempotency)

Caution

Since retrieving the final status takes time, you must set the timeout to 30 seconds.

Parameters

Field Name	Type	Length	Required	Description
mallId	String	8Byte	✅	Merchant ID assigned by KICC
shopTransactionId	String	60Byte	✅	Merchant Transaction ID (API Idempotency Key)
pgCno	String	60Byte	✅	Original Payment Transaction ID (Received in Transaction Creation Response)
cancelPgCno	String	60Byte	✅	Cancellation Transaction ID (Received in Cancellation Request Response)

Request Example

{  
    "mallId": "{Merchant ID}", 
    "shopTransactionId": "{API Idempotency Key}", 
    "pgCno": "{Original Payment Transaction ID}",
    "cancelPgCno": "{Cancellation Transaction ID}"   
}

Response

Parameters

Field Name	Type	Length	Required	Description
resCd	String	4Byte	✅	Response Code
resMsg	String	1000Byte	✅	Response Message
shopTransactionId	String	60Byte	✅	Returns the value sent in the request
mallId	String	8Byte		Merchant ID assigned by KICC
pgCno	String	60Byte		Original Payment Transaction ID
cancelPgCno	String	60Byte		Cancellation Transaction ID
transactionDate	String	14Byte		Transaction Date/Time (yyyyMMddHHmmss)
cancelStatus	String	4Byte		Transaction Status Approved: “TS01” Full Cancel: “TS02” Partial Cancel: “TS06” Network Cancel (Void): “TS12”
resDetailMsg	String	1024Byte		Detailed error message from WeChat (URL encoded)
amountInfo	Object			Cancellation Amount Info (See amountInfo below)

amountInfo (Cancellation Amount Info)

Field Name	Type	Length	Required	Description
currency	String	2Byte	✅	Currency Code
totAmount	Number		✅	Total Cancellation Amount

Response Example

{
   "resCd": "0000",
   "resMsg": "Success",
   "shopTransactionId": "{API Idempotency Key}",
   "mallId": "{Merchant ID}",   
   "pgCno": "{Original Payment Transaction ID}",
   "cancelPgCno": "{Cancellation Transaction ID}",
   "transactionDate": "20230312000512",
   "cancelStatus": "TS02",
   "amountInfo": {
      "currency": "KRW",
      "totAmount": 1000
   }
}