價金保管-使用後核銷API技術文件

查詢作業 / 下載訂單明細檔

應用場景

特店可使用發行日期，呼叫此API下載訂單明細及票券明細資料。

❗ 注意事項：

  • 此API設有呼叫頻率限制，限制條件為每個 [MerchantID] 在一分鐘內僅可下載一個CSV檔案。

API介接網址

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

HTTPS傳輸協定

  • Content Type：application/json
  • HTTP Method：POST

綠界Request參數說明 (JSON格式)

PlatformID String(10)
平台商或POS商編號

平台商或POS商在綠界的會員編號[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": "",
    "MerchantID": "2000132",
    "RqHeader": {
        "Timestamp": 1525168923
    },
    "Data": "…",
    "CheckMacValue": "…"
}

Data參數說明(JSON格式)

❗ 注意事項：請在加密前對參數值進行 URLEncode

MerchantID String(10)
特店編號 必填

ReportType Int
下載資料類別 必填

  • 1：訂單明細檔
  • 2：票券明細檔

BeginDate String(8)
查詢發行日期起值 必填

查詢區間最大為3個月，格式為：yyyymmdd

EndDate String(8)
查詢發行日期迄值 必填

查詢區間最大為3個月，格式為：yyyymmdd

Data參數範例(JSON格式)

				
					{
    "MerchantID": "2000132",
    "ReportType": 1,
    "BeginDate": "20230601",
    "EndDate": "20230630"
}

❗ 注意事項：當ReportType=1時，下載CSV檔案內容為【訂單明細檔】

綠界Response參數說明 (CSV檔案)

特店訂單編號 String

贈品單號 String

ECT訂單編號 String

金流服務商 String

  • 綠界金流

付款方式 String

此筆訂單交易的付款方式

  • 1：信用卡

❗ 注意事項：

  • 訂單發行票券包含提貨券時，此欄位才會回傳值。

信用卡授權單號 Int

發行狀態 String

  • 發行成功
  • 發行失敗
  • 發行作業處理中

發行結果備註 String

發行日期 String

格式為：yyyy/mm/dd hh:mm:ss

出券類型 String

  • 超商票券
  • 紙本票券
  • 電子票券
  • 純序號

列印方式 String

  • 綠界列印
  • 廠商列印

購買人姓名 String

購買人手機 String

購買人Email String

履約保障到期日 String

格式為：yyyy/mm/dd

訂單序號總數量 String

此筆訂單發行的序號數量

訂單金額 String

已核銷序號數量 String

已核銷總金額 String

已退貨序號數量 String

已退貨總金額 String

退貨手續費總金額 String

未使用序號數量 String

未使用序號總金額 String

已失效票券數量 String

❗ 注意事項：當ReportType=2時，下載CSV檔案內容為【票券明細檔】

綠界Response參數說明 (CSV檔案)

特店訂單編號 String

贈品單號 String

ECT訂單編號 String

信用卡授權單號 Int

發行日期 String

格式為：yyyy/mm/dd hh:mm:ss

出券類型 String

  • 超商票券
  • 紙本票券
  • 電子票券
  • 純序號

列印方式 String

  • 綠界列印
  • 廠商列印

票券類型 String

  • 提貨券
  • 贈品券

購買人姓名 String

購買人手機 String

購買人Email String

履約保障到期日 String

格式為：yyyy/mm/dd

票券序號 String

票券使用狀態 String

  • 未使用，代表票券發行後尚未使用
  • 已核銷，票券核銷使用後狀態即為已核銷
  • 已退貨，票券執行退貨後狀態即為已退貨
  • 已失效，代表贈品券已到期

商品編號 String

商品名稱 String

票券面額 String

票券生效日 String

格式為：yyyy/mm/dd

核銷日期 String

票券執行核銷的時間，格式為：yyyy/mm/dd hh:mm

退貨日期 String

票券執行退貨的時間，格式為：yyyy/mm/dd hh:mm

退貨手續費 String

贈品券到期日期 String

票券發行時設定之贈品券到期日，格式為：yyyy/mm/dd

核銷代碼 String

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

綠界官方網站