應用場景
當提貨券訂單於履約保障期間內發生退款時，綠界會每日定時以排程主動發出退款通知，平台商或特店接收綠界退款主動通知後，應正確回應接收訊息。
- Step 1. 綠界：以ServerPost方式傳送退款通知訊息至平台商或特店指定的Server網址(RefundNotifyURL)
- Step 2. 平台商/特店：收到綠界的退款主動通知訊息，並判斷檢查碼是否相符
- Step 3. 平台商/特店：檢查碼相符後，RtnCode請回應1
注意事項：
- 平台商/特店提供的[RefundNotifyURL] Domain需事先與綠界申請開通防火牆。
- 若未正確回應(RtnCode=1)，系統會隔5~15分鐘後重發訊息給平台商/特店，當天重複發送四次。
- 若平台商/特店持續收到綠界回傳的退款主動通知，此時請檢查是否未正確回應(RtnCode=1)給綠界。
- 亦可使用[查詢訂單退款資訊API]查詢訂單退款狀態
HTTPS傳輸協定
- Accept：text/html
- Content Type：application/json
- HTTP Method：POST
綠界Request參數說明 (JSON格式)
PlatformID String(10)
平台商或POS商編號
平台商或POS商在綠界的會員編號[MerchantID]
MerchantID String(10)
特店編號 必填
RqHeader Object
傳輸資料 必填
Timestamp Number
傳入時間 必填
注意事項：
- 驗證時間區間暫訂為10分鐘內有效，若超過此驗證時間則此次訂單將無法建立，參考資料：http://www.epochconverter.com/。
- 合作特店須進行主機「時間校正」，避免主機產生時差，延伸API無法正常運作。
Data String
加密資料 必填
回傳相關資料，此為加密過JSON格式的資料。加密方法說明
CheckMacValue String
檢查碼 必填
請參考附錄檢查碼機制進行計算
綠界Request參數範例 (JSON格式)
{
"PlatformID": "3002599",
"MerchantID": "2000132",
"RqHeader": {
"Timestamp": 1525168923
},
"Data": "…",
"CheckMacValue": "…"
}
Data參數說明(JSON格式)
注意事項：請在加密前對參數值進行 URLEncode
MerchantID String(10)
特店編號
MerchantTradeNo String(25)
特店訂單編號
- 特店訂單編號均為唯一值，不可重複使用。
- 英數字大小寫混合
TradeAmount Int
訂單金額
TotalRefundAmount Int
已退款總金額
此筆訂單已退款金額總計，不含本次退款金額
RefundAmount Int
退款金額
本次退款金額
Data參數範例(JSON格式)
{
"MerchantID": "2000132",
"MerchantTradeNo":"CBX20220302153064851",
"TradeAmount":1000,
"TotalRefundAmount":500,
"RefundAmount":200
}
特店Response參數說明 (JSON格式)
PlatformID String(10)
平台商或POS商編號
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": "3002599",
"MerchantID": "2000132",
"RpHeader": {
"Timestamp": 1525169058
},
"TransCode": 1,
"TransMsg": "",
"Data": "…",
"CheckMacValue": "…"
}
Data參數說明(JSON格式)
RtnCode Int
回應代碼
平台商成功接收綠界通知並檢核檢查碼(CheckMacValue)相符後，RtnCode請回應1
RtnMsg String(200)
回應訊息
Data參數範例(JSON格式)
{
"RtnCode": 1,
"RtnMsg": "成功"
}
注意事項：
- 退款金額為執行退款後，系統更新票務資料並經銀行端確認之款項。
- 配合銀行端作業時間，退款通知發送時間說明如下：
- 票券發行日=退貨日：發行日+2日的02:00後發送。
例如：7/1 10:00發行、7/1 15:00退貨，排程將於7/3 02:00後陸續發送退款通知。
- 票券發行日≠退貨日：退貨隔天的02:00後發送。
例如：7/1 10:00發行、7/5 21:00退貨，排程將於7/6 02:00後陸續發送退款通知。
- 票券發行日=退貨日：發行日+2日的02:00後發送。