Skip to content

Integrate JKO QRCode Pay Refund

Description

JKO Pay 條碼支付退款。
JKO Pay 金流參數：特店代碼、特店密鑰、商店編號
情境：

  • 依廠商金流參數設定進行付款：金流參數為必填、門市代碼不需要填
  • 依全通路金流參數設定進行付款：門市代碼為必填、金流參數不需要填

Resource

POST /v1/payment/integrate/refund

Authorization

採用 OAuth 2.0 Bearer Token，詳細使用流程請參考 Auth Login。

Request Body Parameters

Name Type Description
type string 付款方式，請輸入 JKO_QRCODE_PAY
request Request 請求參數
store_id string 門市代碼
(optional)
is_test boolean 是否為測試環境
  • 在全通路正式環境預設為false
  • 在全通路測試環境預設為true
(optional)

Request Body Parameters - Request

Name Type Description
MerchantID string 特店代碼
(optional)
MerchantKey string 特店密鑰
(optional)
StoreID string 商店編號
(optional)
StoreName string 商店名稱
GatewayTradeNo string 銀行端交易序號
(optional)
MerchantTradeNo string 商店端交易序號(退款流水號)
需為唯一值，不可重複
PosID string POS 機號
PosTradeTime string POS 端交易日期時間
格式：yyyy/MM/dd HH:mm:ss
TradeNo string 原街口端交易序號
POS 端需比對客戶退款單號是否正確
TradeAmount integer 退款金額
Remark string 備註
(optional)
Extra1 string 保留欄位一
(optional)
Extra2 string 保留欄位二
(optional)
Extra3 string 保留欄位三
(optional)
SendTime string 交易發送日期時間
格式：yyyyMMddHHmmss

Request

{
  "type": "JKO_QRCODE_PAY",
  "request": {
    "MerchantID": "9999999",
    "MerchantKey": "2AA6B9B6F9C64247ABB2677B6AF2C896",
    "StoreID": "9999999",
    "StoreName": "街口測試",
    "GatewayTradeNo": "",
    "MerchantTradeNo": "2020009041651",
    "PosID": "1",
    "PosTradeTime": "2020/08/01 10:05:11",
    "TradeNo": "J0065220120100700005",
    "TradeAmount": 10,
    "Remark": "",
    "Extra1": "",
    "Extra2": "",
    "Extra3": "",
    "SendTime": "202008011005"
  },
  "store_id": "0",
  "is_test": false
}

Response Body Parameters

Name Type Description
MerchantID string 特店代碼
StoreID string 商店編號
GatewayTradeNo string 銀行端交易序號
(optional)
MerchantTradeNo string 商店端交易序號(退款流水號)
PosID string POS 機號
TradeAmount integer 退款金額
DebitAmount integer 付款方式退款金額
AvailableAmount integer 儲值帳戶餘額，目前此欄位預設為 0
TradeNo string 原街口端交易序號
RefundTradeNo string 街口端退款交易序號
RefundTradeTime string 街口端退款交易日期時間
格式：yyyy/MM/dd HH:mm:ss
StatusCode Status Code 回應碼，000為成功
StatusDesc string 回應碼說明
IsRep string 是否為重複交易
  • 0：非重複交易
  • 1：重複交易
ActionCode string 建議處理代碼
保留欄位
PaymentType integer 退回方式
  • 1：儲值帳戶
  • 3：銀行帳戶(Account Link)
  • 4：信用卡
RedeemName string 折抵方式(三擇一)，無折抵則回覆空字串
  • Coin：街口折抵
    (所有由街口提供之折抵方式：含街口幣與官方街口券等)
  • Store：店家折抵
    (所有由店家提供之折抵方式：含店家街口券等)
  • Coin, Store：街口折抵 + 店家折抵
    (使用上述兩種折抵方式)
RedeemAmount integer 退還街口折抵金額，此欄位為正值
(optional)
StoreRedeemAmount integer 店家折抵金額，此欄位為正值
該筆交易有店家折抵才會回應此欄位
(optional)
InvoiceVehicle string 手機條碼發票載具資訊
(optional)
MerMemToken string 第三方合作廠商會員識別資訊
(optional)
Remark string 備註
(optional)
Extra1 string 保留欄位一
(optional)
Extra2 string 保留欄位二
(optional)
Extra3 string 保留欄位三
(optional)

Response

{
  "MerchantID": "9999999",
  "StoreID": "9999999",
  "GatewayTradeNo": "",
  "MerchantTradeNo": "2020009041651",
  "PosID": "1",
  "TradeAmount": 10,
  "DebitAmount": 7,
  "AvailableAmount": 0,
  "TradeNo": "J0065220120100700005",
  "RefundTradeNo": "K0065220120100700005",
  "RefundTradeTime": "2020/10/07 20:18:07",
  "StatusCode": "000",
  "StatusDesc": "交易成功",
  "IsRep": 0,
  "ActionCode": "0",
  "PaymentType": 1,
  "RedeemName": "Coin",
  "RedeemAmount": 2,
  "StoreRedeemAmount": 1,
  "InvoiceVehicle": "/7DX6J02",
  "MerMemToken": "",
  "Remark": "",
  "Extra1": "",
  "Extra2": "",
  "Extra3": ""
}

Response Body Parameters - Status Code

Status Code Description
000 交易成功
801 JKOS-Gateway 失敗 - Gateway 連線異常
802 JKOS-Gateway 失敗 - 交易失敗{errCode}
{errCode}：為銀行回傳之失敗代碼
811 與原交易參數不符，無法查詢
901 未明確定義錯誤
902 來源 IP 不被允許
903 加解密失敗
904 加簽或驗簽失敗
905 解析資料失敗
906 條碼已失效
907 非街口合作店鋪
908 特店資料無法交易
909 寫入資料失敗
910 時間戳章驗證失敗
911 金流介接失敗
912 查無會員
913 請消費者重新登入或確認手機為正確時間之後再嘗試
914 條碼已使用，請重新產生
915 不支援街口支付功能
916 查無此訂單
917 退款失敗，電子支付可提領餘額不足
918 退款失敗，支付金額為 0 元，不可退款
919 JKOS 交易失敗
920 特店交易無法使用該發卡行信用卡
921 信用卡尚未通過驗證流程，此交易已超過額度上限
922 922 退款總金額已超過原付款交易金額[含多次退款]
923 退款失敗，街口幣餘額不足無法退款
924 信用卡尚未通過驗證流程
925 請確認是否重複退款
926 資料格式不符合 Json Format
927 條碼錯誤
928 消費者街口帳戶餘額不足
929 不支援此支付方式
931 交易金額已達限額
932 店家收款金額已達限額
934 訂單狀態異常，無法退款
935 交易金額已達每日店鋪限額
939 學生儲值卡餘額不足
940 支付金額不可小於等於 0 元
941 用戶未確認交易或取消交易
951 退款造成街口帳戶支出，故拒絕退款
961 退款金額需收回街口幣或現金回饋，造成信用卡退刷金額異常
962 退款失敗，儲值卡退款失敗
968 此筆交易有使用街口券，無法部份退款
975 退款金額大於店家累計未請款金額，故退款失敗
977 目前此用戶無法使用街口服務，如需啟用可洽街口客服 02-87717212 (977)
978 用戶已銷戶，無法使用街口服務，如有疑問可洽街口客服 02-87717212 (978)
980 交易失敗，該店鋪已下線