付款 API

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

請求參數

參數名稱資料型態最大長度必要說明
MerchantIDString10Y特店代碼,請依街口提供的測試/正式商店代碼更新
StoreIDString20Y商店編號
StoreNameString100Y商店名稱,請帶入半形字元
GatewayTradeNoString20Y銀行端交易序號。若無,請放空值
MerchantTradeNoString60Y商店端交易序號(付款流水號) 需為唯一值,不可重複
PosIDString20YPOS 機號
PosTradeTimeString19YPOS 端交易日期時間,格式:yyyy/MM/dd HH:mm:ss
CardTokenString18Y支付條碼
格式:2碼固定值”22″ + 16碼亂數字串
TradeAmountint Y實際消費金額
UnRedeemint Y不可折抵金額。若無請放 0
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": 10,
  "UnRedeem": 0,
  "Sign":  "626f22697838add43d77954695e3e2dac5f44a4c2ba8a0de405cbbb6175afd2d"
}

返回參數

參數名稱資料型態最大 長度必要說明
MerchantIDString10Y同 request
StoreIDString20Y同 request
GatewayTradeNoString20 同 request
MerchantTradeNoString60Y同 request
PosIDString20Y同 request
TradeNoString25Y街口端交易序號
TradeTimeString19Y街口端交易日期時間,格式:yyyy/MM/dd HH:mm:ss
StatusCodeString3Y回應碼 000:表示交易成功
請參照【1.2回應碼(StatusCode)】章節。
StatusDescString1000Y回應碼說明
IsRepString1Y是否為重複交易
0:非重複交易
1:重複交易
ActionCodeString1Y建議處理代碼,保留欄位
PaymentTypeint Y付款方式
1:儲值帳戶
3:銀行帳戶(Account Link)
4:信用卡
TradeAmountint Y同 request
DebitAmountint Y付款方式扣款金額(折抵後金額)
RedeemNameString10Y折抵方式(三擇一),無折抵則回覆空字串
Coin:街口折抵(所有由街口提供之折抵方式:含街口幣與官方街口券等)
Store:店家折抵(所有由店家提供之折抵方式:含店家街口券等)
Coin, Store:街口折抵 + 店家折抵(使用上述兩種折抵方式)
RedeemAmountint  街口折抵金額,此欄位為負值
StoreRedeemAmountint C店家折抵金額,此欄位為負值
該筆交易有店家折抵才會回應此欄位
AvailableAmountint Y儲值帳戶餘額,目前此欄位預設為 0
InvoiceVehicleString20 手機條碼發票載具資訊
MerMemTokenString30 第三方合作廠商會員識別資訊
RemarkString1000 同 request
Extra1String512 同 request
Extra2String512 同 request
Extra3String512 信用卡資訊:當PaymentType = 4(信用卡)時,此欄位才會以 Json 字串回傳卡名及卡號前六後四碼,其餘皆為空
格式:{“CardName”: “XX卡”, “CardNo”: “222222******3333”}

範例如下:

{
    "MerchantID": "9999999",
    "StoreID": "9999999",
    "GatewayTradeNo": "",
    "MerchantTradeNo": "2020009041651",
    "PosID": "1",
    "TradeNo": "J0065220120100700005",
    "IsRep": 0,
    "PaymentType": 1,
    "TradeAmount": 10,
    "DebitAmount": 7,
    "RedeemName": "Coin",
    "RedeemAmount": -3,
    "AvailableAmount": 0,
    "InvoiceVehicle": "/7DX6J02",
    "MerMemToken": "",
    "Remark": "",
    "Extra1": "",
    "Extra2": "",
    "Extra3": "{\"CardName\":\"街口帳戶\",\"CardNo\":\"123459003417190\"}",
    "ActionCode": "0",
    "StatusCode": "000",
    "StatusDesc": "交易成功",
    "TradeTime": "2020/10/07 20:11:51"
}