應用場景
當票券完成核銷時，綠界會每日定時以排程主動發出核銷通知，平台商或特店接收綠界核銷主動通知後，應正確回應接收訊息。
- Step 1. 綠界：以ServerPost方式傳送核銷通知訊息至平台商或特店指定的Server網址(RedempNotifyURL)
- Step 2. 平台商/特店：收到綠界的核銷主動通知訊息，並判斷檢查碼是否相符
- Step 3. 平台商/特店：檢查碼相符後，RtnCode請回應1
注意事項：
- 平台商/特店提供的[RedempNotifyURL] Domain需事先與綠界申請開通防火牆。
- 若未正確回應(RtnCode=1)，系統會隔5~15分鐘後重發訊息給平台商/特店，當天重複發送四次。
- 若平台商/特店持續收到綠界回傳的核銷主動通知，此時請檢查是否未正確回應(RtnCode=1)給綠界。
- 亦可使用[查詢票券明細API]查詢訂單核銷狀態
HTTPS傳輸協定
- Accept：text/html
- Content Type：application/json
- HTTP Method：POST
綠界Request參數說明 (Json格式)
PlatformID String(10)
平台商編號
平台商在綠界的會員編號[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格式)
MerchantID String(10)
特店編號
MerchantTradeNo String(25)
特店訂單編號
FreeTradeNo String(20)
贈品單號
TicketList Array[Object]
票券核銷清單
TicketNo String(16)
票券序號
TicketType String(1)
票券類型
- 1：提貨券
- 2：贈品券
RedeemDate String(20)
操作核銷時間
格式為：yyyymmdd hh:mm
RedeemMID String(10)
核銷特店編號
執行核銷的特店編號
RedeemStoreID String(20)
核銷分店編號
執行核銷的分店編號，如為空值代表此筆是由總店執行核銷。
TicketAmount Int
票券面額
Data參數範例(Json格式)
{
"MerchantID": "2000132",
"MerchantTradeNo":"CBX20220302153064851",
"FreeTradeNo":"",
"TicketList":[
{
"TicketNo":"CB2SY20220302153",
"TicketType":"1",
"RedeemDate":"20231010 15:31",
"RedeemMID":"2000132",
"RedeemStoreID":"",
"TicketAmount":1000
},
{
"TicketNo":"CB2SY20220302154",
"TicketType":"1",
"RedeemDate":"20231010 15:32",
"RedeemMID":"2000132",
"RedeemStoreID":"",
"TicketAmount":1000
},
{
"TicketNo":"CB2SY20220302155",
"TicketType":"1",
"RedeemDate":"20231010 15:33",
"RedeemMID":"2000132",
"RedeemStoreID":"",
"TicketAmount":1000
}
]
}
特店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": "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": "成功"
}
注意事項：
- 為配合銀行端作業，每日執行核銷之資料，將於隔日更新至價金保管系統，更新後此筆票券即為「核銷完成」。
- 承上，核銷通知發送時間為「核銷完成」的隔日02:00起陸續發送。
例如：7/5 21:00完成核銷，排程將於7/6 02:00後開始發送。