主動通知 / 核退主動通知

應用場景

當訂單核銷或退貨完成後,綠界會每日定時以排程主動發出核退通知,平台商或特店成功接收綠界通知後,應正確回應接收訊息。

  • Step 1. 綠界:以ServerPost方式傳送核退通知訊息至平台商或特店指定的Server網址(UseStatusNotifyURL)
  • Step 2. 平台商/特店:收到綠界的核退主動通知訊息,並判斷檢查碼是否相符
  • Step 3. 平台商/特店:檢查碼相符後,RtnCode請回應1

❗ 注意事項:

  1. 平台商/特店提供的[UseStatusNotifyURL] Domain需事先與綠界申請開通防火牆。
  2. 若未正確回應(RtnCode=1),系統會隔5~15分鐘後重發訊息給平台商/特店,當天重複發送四次
  3. 若平台商/特店持續收到綠界回傳的核退主動通知,此時請檢查是否未正確回應(RtnCode=1)給綠界。
  4. 亦可使用[查詢訂單資訊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
傳入時間 必填

請將傳輸時間轉換為時間戳(GMT+8),綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。

❗ 注意事項

  • 驗證時間區間暫訂為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)
特店訂單編號 

FreeTradeNo String(20)
贈品單號 

TicketList Array[Object]
核銷或退貨的票券清單

TicketType String(1)
票券類型

  • 1:提貨券
  • 2:贈品券

TicketNo String(16)
票券序號

TicketPrice Int
票券面額

ChangeType String(1)
異動類別

  • 1:核銷完成
  • 2:退貨完成

ChangeMID String(10)
執行異動的特店編號

執行此筆票券核銷或退貨的特店編號

ChangeStoreID String(20)
執行異動的分店編號

執行此筆票券核銷或退貨的分店

ChangeDate String(14)
執行異動的日期

執行此筆票券核銷或退貨的日期,格式為:yyyymmdd

CompleteDate String(14)
異動完成日期

核銷或退貨上傳完成日期,格式為:yyyymmdd

Data參數範例(JSON格式)

				
					{
    "MerchantID": "2000132",
    "MerchantTradeNo":"CBX20220302153064851",
    "FreeTradeNo":"",
    "TicketList":[
        {
            "TicketType":"1",
            "TicketNo":"CB2SY20220302153",
            "TicketPrice":250,
            "ChangeType":"1",
            "ChangeMID":"2000132",
            "ChangeStoreID":"",
            "ChangeDate":"20231212",
            "CompleteDate":"20231213"
        },
        {
            "TicketType":"1",
            "TicketNo":"CB2SY20220302154",
            "TicketPrice":250,
            "ChangeType":"1",
            "ChangeMID":"2000132",
            "ChangeStoreID":"",
            "ChangeDate":"20231212",
            "CompleteDate":"20231213"
        },
        {
            "TicketType":"2",
            "TicketNo":"CB2SY20220302155",
            "TicketPrice":250,
            "ChangeType":"1",
            "ChangeMID":"2000132",
            "ChangeStoreID":"",
            "ChangeDate":"20231212",
            "CompleteDate":"20231213"
        },
        {
            "TicketType":"2",
            "TicketNo":"CB2SY20220302156",
            "TicketPrice":250,
            "ChangeType":"1",
            "ChangeMID":"2000132",
            "ChangeStoreID":"",
            "ChangeDate":"20231212",
            "CompleteDate":"20231213"
        },
    ]
}

				
			

綠界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": "成功"
}

				
			

❗ 注意事項:

  1. 系統會於操作核銷或退貨的隔日凌晨01:00,變更票券狀態為已核銷/已退貨

  2. 票券使用狀態為已核銷已退貨,將於每日凌晨03:00開始發送核退主動通知。

Copyright © Green World FinTech Service Co., Ltd. All rights reserved.

綠界官方網站