查詢作業 / 查詢票券發行結果

應用場景

電子票券及超商票券於[票券發行API]的回傳結果,僅代表票券發行資料接收成功,綠界會再以排程方式處理票券訂單建立及發行,票券發行後可再呼叫此API查詢最新的票券發行結果。

API介接網址

  • 測試環境:https://ecticket-stage.ecpay.com.tw/api/Ticket/QueryIssueResult
  • 正式環境:https://ecticket.ecpay.com.tw/api/Ticket/QueryIssueResult

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]須擇一必填,且僅可填寫其中一項
  • 限英、數字

FreeTradeNo String(20)
贈品單號

❗ 注意事項

  • 此欄位與[MerchantTradeNo]須擇一必填,且僅可填寫其中一項
  • 限英、數字

Data參數範例(Json格式)

				
					{
    "MerchantID": "2000132",
    "MerchantTradeNo":"CBX20220302153064851",
    "FreeTradeNo":""
}

				
			

綠界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
回應代碼

1為查詢成功,其餘為失敗

RtnMsg String(200)
回應訊息

MerchantTradeNo String(25)
特店訂單編號

FreeTradeNo String(20)
贈品單號

Status Int
發行結果

  • 1:成功
  • 2:失敗
  • 3:處理中

Remark String(100)
發行結果備註

當Status=2(發行失敗)時,會在此欄位說明發行失敗原因

Data參數範例(Json格式)

				
					{
    "RtnCode": 1,
    "RtnMsg": "成功",
    "MerchantTradeNo":"CBX20220302153064851",
    "FreeTradeNo":"",
    "Status": 2,
    "Remark": "錯誤,請確認該筆訂單交易金額與商品總額相同"
}

				
			

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

綠界官方網站