應用場景
提供查詢履約保障期間內的提貨券訂單退款資訊，此退款金額於執行退款後，系統更新票務資料並經銀行端確認才會回傳 。
API介接網址
- 測試環境：https://ecticket-stage.ecpay.com.tw/api/Ticket/QueryRefundInfo
- 正式環境：https://ecticket.ecpay.com.tw/api/Ticket/QueryRefundInfo
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)
特店訂單編號 必填
注意事項：須為包含提貨券的訂單
Data參數範例(JSON格式)
{
"MerchantID": "2000132",
"MerchantTradeNo":"CBX20220302153064851"
}
綠界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
回應代碼
1為成功，其餘為失敗
RtnMsg String(200)
回應訊息
MerchantID String(10)
特店編號
MerchantTradeNo String(25)
特店訂單編號
TradeAmount Int
訂單金額
此筆訂單原始金額
TotalRefundAmount Int
已退款總金額
此筆訂單已退款金額總計
Data參數範例(JSON格式)
{
"RtnCode": 1,
"RtnMsg": "成功"
"MerchantID": "2000132",
"MerchantTradeNo":"CBX20220302153064851",
"TradeAmount":1000,
"TotalRefundAmount":800
}
注意事項：
- 退款金額為執行退款後，系統更新票務資料並經銀行端確認之款項。