取消 API
位置:https://pos.jkopay.com/{系統方名稱}/Cancel
當 POS 端送出付款交易(Payment)後,與街口連線異常或交易逾時,可發送取消交易(Cancel),取消該筆付款。
請求參數
| 參數名稱 | 資料型態 | 最大長度 | 必要 | 說明 | 
|---|---|---|---|---|
| MerchantID | String | 10 | Y | 特店代碼,請依街口提供的測試/正式商店代碼更新 | 
| StoreID | String | 20 | Y | 商店編號 | 
| StoreName | String | 100 | Y | 商店名稱,請帶入半形字元 | 
| GatewayTradeNo | String | 20 | Y | 銀行端交易序號(需與Payment相同) | 
| MerchantTradeNo | String | 60 | Y | 商店端交易序號(付款流水號)(需與Payment相同) | 
| PosID | String | 20 | Y | POS 機號 | 
| PosTradeTime | String | 19 | Y | POS 端交易日期時間,格式:yyyy/MM/dd HH:mm:ss | 
| CardToken | String | 18 | Y | 支付條碼(需與Payment相同) | 
| TradeAmount | int | Y | 實際消費金額(需與Payment相同) | |
| UnRedeem | int | Y | 不可折抵金額(需與Payment相同) | |
| Remark | String | 1000 | Y | 備註。若無,請放空值 | 
| Extra1 | String | 512 | Y | 保留欄位一。若無,請放空值 | 
| Extra2 | String | 512 | Y | 保留欄位二。若無,請放空值 | 
| Extra3 | String | 512 | Y | 保留欄位三。若無,請放空值 | 
| SendTime | String | 14 | Y | 交易發送日期時間,格式:yyyyMMddHHmmss | 
| Sign | String | 64 | Y | 簽章值,請參照【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"
}
返回參數
| 參數名稱 | 資料型態 | 最大長度 | 必要 | 說明 | 
|---|---|---|---|---|
| MerchantID | String | 10 | Y | 同 request | 
| StoreID | String | 20 | Y | 同 request | 
| GatewayTradeNo | String | 20 | 同 request | |
| MerchantTradeNo | String | 60 | Y | 同 request | 
| PosID | String | 20 | Y | 同 request | 
| TradeAmount | int | Y | 同 request | |
| StatusCode | String | 3 | Y | 回應碼 000:表示交易成功 請參照【1.2回應碼(StatusCode)】章節 | 
| StatusDesc | String | 1000 | Y | 回應碼說明 | 
| ActionCode | String | 1 | Y | 建議處理代碼,保留欄位 | 
範例如下:
{
    "MerchantID": "9999999",
    "StoreID": "9999999",
    "MerchantTradeNo": "2020009041651",
    "PosID": "1",
    "TradeAmount": 0,
    "ActionCode": "0",
    "StatusCode": "000",
    "StatusDesc": "交易成功"
}