應用場景
特店可使用廠商訂單編號呼叫此API查詢訂單明細資料
API介接網址
- 測試環境：https://ecticket-stage.ecpay.com.tw/api/Period/QueryOrderInfo
- 正式環境：https://ecticket.ecpay.com.tw/api/Period/QueryOrderInfo
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": "",
"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)
平台商編號
目前尚未開放
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": "",
"MerchantID": "2000132",
"RpHeader": {
"Timestamp": 1525169058
},
"TransCode": 1,
"TransMsg": "",
"Data": "…",
"CheckMacValue": "…"
}
Data參數說明(JSON格式)
RtnCode Int
回應代碼
1為成功，其餘為失敗
RtnMsg String(200)
回應訊息
MerchantID String(10)
特店編號
MerchantTradeNo String(25)
特店訂單編號
TicketTradeNo String(16)
ECT訂單編號
由ECTicket系統提供的訂單編號
CreditTradeID Int
信用卡授權單號
Status Int
發行結果
- 1：發行成功
- 2：發行失敗
- 3：發行作業處理中
Remark String(100)
發行結果備註
IssueDate String(20)
發行日期
格式為：yyyy/mm/dd hh:mm:ss
EscrowExpireDate String(8)
履約保障到期日
格式為：yyyymmdd
TotalCount Int
訂單序號總數量
TradeAmount Int
訂單金額
RedeemCount Int
已核銷序號數量
RedeemAmount Int
已核銷總金額
RefundCount Int
已退貨序號數量
RefundAmount Int
已退貨總金額
TotalRefundFee Int
退貨手續費總金額
退款金額中已向消費者收取的退貨手續費總計
RefundDate String(8)
訂單退貨日期
格式為：yyyymmdd
UnUsedCount Int
未使用序號數量
UnUsedAmount Int
未使用總金額
TicketList Array[Object]
分期核銷序號清單
Data參數範例(JSON格式)
{
"RtnCode": 1,
"RtnMsg": "成功"
"MerchantID": "2000132",
"MerchantTradeNo":"CBX20230302153064851",
"TicketTradeNo":"2023061012345678",
"CreditTradeID":12456789,
"Status":1,
"Remark":"",
"IssueDate":"2023/06/10 10:35:21",
"EscrowExpiredDate":"20231210",
"TotalCount":3,
"TradeAmount":9000,
"RedeemCount":1,
"RedeemAmount":3000,
"RefundCount":2,
"RefundAmount":600,
"TotalRefundFee":80,
"RefundDate":"20230630",
"UnUsedCount":0,
"UnUsedAmount":0,
"TicketList":[…]
}
TicketList參數說明(JSON格式)
TicketNo String(16)
分期核銷序號
UseStatus Int
序號使用狀態
- 1：未使用，代表序號發行後尚未使用
- 2：已核銷，序號核銷使用後狀態即為已核銷
- 3：已退貨，序號執行退貨後狀態即為已退貨
TicketAmount Int
序號面額
WriteOffDate String(8)
核銷日期
格式為：yyyymmdd
TicketList參數範例(JSON格式)
[
{
"TicketNo": "CX12345600001",
"UseStatus": 2,
"TicketAmount": 1200,
"WriteOffDate":"20230601"
},
{
"TicketNo": "CX12345600002",
"UseStatus": 2,
"TicketAmount": 1200,
"WriteOffDate":"20230622"
},
{
"TicketNo": "CX12345600003",
"UseStatus": 1,
"TicketAmount": 1200,
"WriteOffDate":""
},
{
"TicketNo": "CX12345600004",
"UseStatus": 1,
"TicketAmount": 1200,
"WriteOffDate":""
}
]