查詢訂單 / 查詢訂單

應用場景

提供特店查詢訂單資訊，可透過此API來過濾是否為有效訂單。

注意事項：

當取得付款結果通知時，請呼叫查詢訂單API驗證付款結果
在訂單產生後未收到綠界通知的付款結果
- 信用卡、Apple Pay及銀聯卡付款方式
  - 請於付款後10分鐘使用API查詢付款結果。若遇到銀行尚未回覆的情況，查詢結果中的TradeStatus交易狀態為0：未付款，請再過10分鐘後重新查詢訂單。
  - 或在付款後40分鐘後再呼叫API查詢付款結果，以避免重複呼叫查詢API。
- ATM、CVS、BARCODE付款方式
  - 因為為離線付款方式，請待綠界通知的付款結果。
若有多筆訂單查詢的需求，請參考下載特店對帳媒體檔。

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(10)
特店編號 必填

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必須與PlatformID帶入相同值。

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)
付款方式

PaymentDate String(20)
付款時間

格式為 yyyy/MM/dd HH:mm:ss

ChargeFee Number
手續費

TradeStatus String(8)
交易狀態

CardInfo Object
信用卡授權資訊

AuthCode String(6)
銀行授權碼

Gwsr Int
授權交易單號

ProcessDate String(20)
交易時間

格式為 yyyy/MM/dd HH:mm:ss

Amount Int
金額

Stage Int
分期期數

Stast Int
首期金額

Staed Int
各期金額

Eci Int
3D(VBV) 回傳值

Eci=5,6,2,1 代表該筆交易為3D交易

Card6No String(6)
信用卡卡號前六碼

Card4No String(4)
信用卡卡號末四碼

RedDan Int
紅利扣點

使用信用卡紅利時回傳

RedOkAmt Int
實際扣款金額

使用信用卡紅利時回傳

RedYet Int
紅利剩餘點數

使用信用卡紅利時回傳

PeriodType String(1)
週期種類

定期定額時回傳，訂單建立時所設定的週期種類

Frequency Int
執行頻率

定期定額時回傳，訂單建立時所設定的執行頻率

ExecTimes Int
執行次數

定期定額時回傳，訂單建立時所設定的執行次數

PeriodAmount Int
訂單建立時的每次要授權金額

定期定額時回傳

TotalSuccessTimes Int
目前已成功授權的次數

定期定額時回傳，目前已成功授權的次數

TotalSuccessAmount Int
目前已成功授權的金額合計

定期定額時回傳

IssuingBank String(30)
銀行名稱

IssuingBankCode String(10)
銀行代碼

CVSInfo Object
超商代碼資訊

PaymentNo String(14)
繳費代碼

PayFrom String(10)
繳費超商

PaymentURL String(100)
繳費連結

由綠界科技提供手機上顯示的三段式繳費條碼網頁

PayStoreID String(15)
繳費超商門市代碼

依超商傳回門市代碼範例:166843

PayStoreName String(30)
繳費超商門市名稱

依超商傳回門市名稱範例:板橋德民店

BarcodeInfo Object
超商條碼資訊

回傳只有三段號碼，並不會回傳條碼圖，需自行轉換成 code39 的三段條碼

PayFrom String(10)
繳費超商

ATMInfo Object
ATM資訊

ATMAccBank String(3)
付款人銀行代碼

ATMAccNo String(5)
付款人銀行帳號後五碼

CustomField String(200)
自訂欄位

提供特店使用客制化欄位

Data參數範例(Json格式)

				
					{
    "RtnCode": 1,
    "RtnMsg": "Success",
    "MerchantID": "3002607",
    "OrderInfo": {
        "MerchantTradeNo": "20180914001",
        "TradeNo": "1809261503338172",
        "TradeDate" :"2018/09/26 14:59:54"
    },
    "CardInfo": {
        "Gwsr": 10735183,
        "ProcessDate": "2018/09/26 14:59:54",
        "AuthCode": "777777",
        "Amount": 100,
        "Eci": 2,
        "Card4No": "2222",
        "Card6No": "491122",
        "RedDan": 0,
        "RedOkAmt": 0,
        "RedYet": 0
    }
}

綠界官方網站