應用場景
提供可使用此API執行訂單退貨或取消退貨作業
API介接網址
- 測試環境：https://ecticket-stage.ecpay.com.tw/api/Period/OrderRefund
- 正式環境：https://ecticket.ecpay.com.tw/api/Period/OrderRefund
HTTPS傳輸協定
- Accept：text/html
- Content Type：application/json
- HTTP Method：POST
特店Request參數說明 (JSON格式)
PlatformID String(10)
平台商編號
目前尚未開放
平台商在綠界的會員編號[MerchantID]
MerchantID String(10)
特店編號 必填
RqHeader Object
傳輸資料 必填
Timestamp Number
傳入時間 必填
請將傳輸時間轉換為時間戳(GMT+8)，綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。
注意事項：
- 驗證時間區間暫訂為10分鐘內有效，若超過此驗證時間則此次訂單將無法建立， 參考資料：http://www.epochconverter.com/。
- 合作特店須進行主機「時間校正」，避免主機產生時差，延伸API無法正常運作。
Data String
加密資料 必填
回傳相關資料，此為加密過JSON格式的資料。加密方法說明
CheckMacValue String
檢查碼 必填
請參考附錄檢查碼機制進行計算
特店Request參數範例(JSON格式)
{
"PlatformID": "",
"MerchantID": "2000132",
"RqHeader": {
"Timestamp": 1525168923
},
"Data": "…",
"CheckMacValue": "…"
}
Data參數說明(JSON格式)
注意事項：請在加密前對參數值進行 URLEncode
MerchantID String(10)
特店編號 必填
MerchantTradeNo String(25)
特店訂單編號 必填
Action String(1)
執行動作 必填
- 1：退貨
- 2：取消退貨
RefundFee Int
退貨手續費
注意事項：
- 當[Action]=1時，如需指定退貨手續費金額請填寫此欄位，若未填寫則預設為0。
- 退貨手續費總額上限 計算公式：未使用序號總面額 – 未使用序號數量。
範例：訂單內尚有5筆序號未使用，其面額總共500元，則退貨手續費總額上限為500-5=495元 - 退貨手續費金額不可大於退貨手續費總額上限，且不可為負數。
Reason String(50)
退貨或取消退貨原因
Operator String(10)
建立人員 必填
操作此筆訂單退貨/取消退貨人員，僅為歷程紀錄使用
注意事項：
- 限英、數字，且不可使用全形
Data參數範例(JSON格式)
{
"MerchantID": "2000132",
"MerchantTradeNo":"CBX20220302153064851",
"Action":"1",
"RefundFee":495,
"Reason":"",
"Operator":"LeoWang"
}
綠界Response參數說明 (JSON格式)
PlatformID String(10)
平台商編號
目前尚未開放
MerchantID String(10)
特店編號
RpHeader Object
回傳資料
Timestamp Number
回傳時間
時間戳 Unix timestamp
TransCode Int
回傳代碼
1 代表 API 傳輸資料 (PlatformID, MerchantID, RqHeader, Data) 接收成功，實際的API執行結果狀態請參考 RtnCode 參數
TransMsg String(200)
回傳訊息
Data String
加密資料
此參數為加密過的 JSON 格式資料。加密方法說明
CheckMacValue String
檢查碼
請參考附錄檢查碼機制進行計算
綠界Response參數範例 (JSON格式)
{
"PlatformID": "",
"MerchantID": "2000132",
"RpHeader": {
"Timestamp": 1525169058
},
"TransCode": 1,
"TransMsg": "",
"Data": "…",
"CheckMacValue": "…"
}
Data參數說明(JSON格式)
RtnCode Int
回應代碼
1為成功，其餘為失敗
RtnMsg String(200)
回應訊息
Data參數範例(JSON格式)
{
"RtnCode": 1,
"RtnMsg": "成功"
}
注意事項：
- 如欲取消退貨，須於退貨當日23:59前執行。系統將於退貨隔日00:00進行票務更新作業。
- 當訂單的可退貨金額，與廠商及購買人原議定之退款金額不符時，廠商需自行聯繫購買人確認差額款項退還方式。