應用場景
提供特店查詢訂單資訊，可透過此API來過濾是否為有效訂單。
API介接網址
- 測試環境: https://ecpayment-stage.ecpay.com.tw/1.0.0/Cashier/QueryTrade
- 正式環境: https://ecpayment.ecpay.com.tw/1.0.0/Cashier/QueryTrade
HTTPS 傳輸協定
- Content Type：application/json
- HTTP Method：POST
特店Request參數說明 (Json格式)
MerchantID String(20)
特店編號 必填
RqHeader Object
傳輸資料 必填
Timestamp Number
傳輸時間 必填
請將傳輸時間轉換為時間戳(GMT+8)，綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。
注意事項：
- 驗證時間區間為 10 分鐘內有效，若超過此驗證時間則此次訂單將無法建立，產生時間戳請參考相關資料。
- 合作特店須進行主機「時間校正」，避免主機產生時差，導致API無法正常運作。
Data String
加密資料 必填
此參數為加密過的 JSON 格式資料，加密方式請參考說明。
特店Request參數範例 (Json格式)
{
"MerchantID": "3002607",
"RqHeader": {
"Timestamp": 1234567890
},
"Data": "enter your data"
}
Data參數說明(Json格式)
注意事項：請在加密前對參數值進行 URLEncode
PlatformID String(10)
特約合作平台商代號
- 為專案合作的平台商使用
- 一般特店或平台商本身介接，則參數請帶空值
- 專案合作平台商的特店使用時，參數請帶平台商所綁的特店編號 MerchantID
MerchantID String(10)
特店編號 必填
MerchantTradeNo String(20)
特店交易編號 必填
Data參數範例(Json格式)
{
"MerchantID": "3002607",
"MerchantTradeNo": "20180914001"
}
綠界Response參數說明 (Json格式)
MerchantID String(10)
特店編號
RpHeader Object
回傳資料
Timestamp Number
回傳時間
時間戳 Unix timestamp
TransCode Int
回傳代碼
1 代表 API 傳輸資料 (MerchantID, RqHeader, Data) 接收成功，實際的API執行結果狀態請參考 RtnCode 參數
TransMsg String(200)
回傳訊息
Data String
加密資料
此參數為加密過的 JSON 格式資料
綠界Response參數範例 (Json格式)
{
"MerchantID": "3002607",
"RpHeader": {
"Timestamp": 1234564848
},
"TransCode": 1,
"TransMsg": "Success",
"Data": "…"
}
Data參數說明(Json格式)
RtnCode Int
交易狀態
1 代表 API 執行成功，其餘代碼均為失敗，失敗代碼請參考交易訊息代碼表。
RtnMsg String(200)
回應訊息
PlatformID String(10)
平台商編號
MerchantID String(10)
特店編號
OrderInfo Object
訂單資訊
MerchantTradeNo String(20)
特店交易編號
TradeNo String(20)
綠界交易編號
TradeAmt Int
交易金額
TradeDate String(20)
訂單成立時間
PaymentType String(20)
付款方式
- CVS : 超商代碼
- BARCODE : 超商條碼
- ATM: 虛擬帳號
PaymentDate String(20)
付款時間
格式為 yyyy/MM/dd HH:mm:ss
ChargeFee Number
手續費
TradeStatus String(8)
交易狀態
- 若為 0 時，代表交易訂單成立未付款
- 若為 1 時，代表交易訂單成立付款成功
CVSInfo Object
超商代碼資訊
PaymentNo String(14)
繳費代碼
PayFrom String(10)
繳費超商
- family：全家
- hilife：萊爾富
- okmart：OK 超商
- ibon：7-11
PaymentURL String(100)
繳費連結
由綠界科技提供手機上顯示的三段式繳費條碼網頁
BarcodeInfo Object
超商條碼資訊
回傳只有三段號碼，並不會回傳條碼圖，需自行轉換成 code39 的三段條碼
PayFrom String(10)
繳費超商
- family：全家
- hilife：萊爾富
- okmart：OK 超商
- ibon：7-11
ATMInfo Object
ATM資訊
ATMAccBank String(3)
付款人銀行代碼
ATMAccNo String(5)
付款人銀行帳號後五碼
CustomField String(200)
自訂欄位
提供特店使用客制化欄位
Data參數範例(Json格式)
{
"RtnCode": 1,
"RtnMsg": "",
"MerchantID": "2000132",
"OrderInfo": {
"MerchantTradeNo": "20180914001",
"TradeNo": "1809261503338172",
"TradeAmt":100,
"TradeDate" :"2018/09/26 14:59:54",
"PaymentType":"CVS",
"PaymentDate":"2018/09/26 15:00:30",
"ChargeFee":5,
"TradeStatus":"1"
},
"CVSInfo": {
"PayFrom ": "family",
"PaymentNo ": "123456789"
}
}