取消 API

位置:https://pos.jkopay.com/{系統方名稱}/Cancel

當 POS 端送出付款交易(Payment)後,與街口連線異常或交易逾時,可發送取消交易(Cancel),取消該筆付款。

請求參數

參數名稱資料型態最大長度必要說明
MerchantIDString10Y特店代碼,請依街口提供的測試/正式商店代碼更新
StoreIDString20Y商店編號
StoreNameString100Y商店名稱,請帶入半形字元
GatewayTradeNoString20銀行端交易序號(需與Payment相同)
MerchantTradeNoString60Y商店端交易序號(付款流水號)(需與Payment相同)
PosIDString20YPOS 機號
PosTradeTimeString19YPOS 端交易日期時間,格式:yyyy/MM/dd HH:mm:ss
CardTokenString18Y支付條碼(需與Payment相同)
TradeAmountint Y實際消費金額(需與Payment相同)
UnRedeemint Y不可折抵金額(需與Payment相同)
RemarkString1000Y備註。若無,請放空值
Extra1String512保留欄位一。若無,請放空值
Extra2String512保留欄位二。若無,請放空值
Extra3String512保留欄位三。若無,請放空值
SendTimeString14Y交易發送日期時間,格式:yyyyMMddHHmmss
SignString64Y簽章值,請參照【1.1交易簽章規則】章節。
須為全小寫

範例如下:

{
    "CardToken": "22J111111111111111",
    "Extra1": "",
    "Extra2": "",
    "Extra3": "",
    "GatewayTradeNo": "",
    "MerchantID": "9999999",
    "MerchantTradeNo": "2020009041651",
    "PosID": "1",
    "PosTradeTime": "2020/08/01 10:05:11",
    "Remark": "",
    "SendTime": "20200801100511",
    "StoreID": "9999999",
    "StoreName": "街口測試",
    "TradeAmount": 0,
    "UnRedeem": 0,
    "Sign": "4f1ccb409d8503bd810a169b3b31d813faa0c1b5ff8fd5775e2dc6e0cf7eea3b"
}

返回參數

參數名稱資料型態最大長度必要說明
MerchantIDString10Y同 request
StoreIDString20Y同 request
GatewayTradeNoString20 同 request
MerchantTradeNoString60Y同 request
PosIDString20Y同 request
TradeAmountint Y同 request
StatusCodeString3Y回應碼 000:表示交易成功
請參照【1.2回應碼(StatusCode)】章節
StatusDescString1000Y回應碼說明
ActionCodeString1Y建議處理代碼,保留欄位

範例如下:

{
    "MerchantID": "9999999",
    "StoreID": "9999999",
    "MerchantTradeNo": "2020009041651",
    "PosID": "1",
    "TradeAmount": 0,
    "ActionCode": "0",
    "StatusCode": "000",
    "StatusDesc": "交易成功"
}