查詢訂單 ​

(可依特店的需求來決定是否撰寫此API)

查詢訂單 ​

應用場景 ​

提供特店查詢訂單資訊，可透過此API來過濾是否為有效訂單。
Step1. 特店：以Server POST方式傳送以下參數至API網址。
Step2. 歐買尬金流：接受並檢核正確後，回傳訂單資訊參數。

介接路徑 ​

特店傳入參數說明 (名稱前若有紅色星號*為必填欄位)： ​

  • Content Type：application/x-www-form-urlencoded
  • HTTP Method：POST
參數/型態參數名稱說明
*MerchantID
String(10)		特店編號(由歐買尬金流提供)
*MerchantTradeNo
String(20)		特店交易編號訂單產生時傳送給歐買尬金流的特店交易編號。
*TimeStamp
Int		驗證時間將當下的時間轉為 UnixTimeStamp(見範例)用於驗證此次介接的時間區間。
歐買尬金流驗證時間區間暫訂為 3 分鐘內有效，超過則此次介接無效。
參考資料：
https://www.epochconverter.com/
PlatformID
String(10)		特約合作平台商代號(由歐買尬金流提供)為專案合作的平台商使用。
一般特店或平台商本身介接，則參數請帶放空值。
若為專案合作平台商的特店使用時，則參數請帶平台商所綁的特店編號 [MerchantID]。
*CheckMacValue
String		檢查碼請參考附錄檢查碼機制與產生檢查碼範例程式。

歐買尬金流回傳參數說明： ​

  • Content Type：text/html
  • HTTP Method：POST

訂單結果會以下表form-data格式參數直接回傳至頁面，並以「參數=值」
表示參數與參數之間以&隔開，例：
MerchantID = 123456789&MerchantTradeNo=123456abc&TradeNo=20120315174058256423

參數/型態參數名稱說明
MerchantID
String(9)		特店編號
MerchantTradeNo
String(20)		特店交易編號訂單產生時傳送給歐買尬金流的特店交易編號。
StoreID
String(20)		特店旗下店舖代號提供特店填入分店代號使用，僅可用英數字大小寫混合。
TradeNo
String(20)		歐買尬金流的交易編號
TradeAmt
Int		交易金額
PaymentDate
String(20)		付款時間格式為 yyyy/MM/dd HH:mm:ss
PaymentType
String(20)		特店選擇的付款方式
HandlingCharge
Int		手續費合計履約結束後才會計算，未計算前為 0
PaymentTypeChargeFee
Decimal		通路費
TradeDate
String(20)		訂單成立時間格式為 yyyy/MM/dd HH:mm:ss
TradeStatus
String(8)		交易狀態回傳值：
若為 0 時，代表交易訂單成立未付款
若為 1 時，代表交易訂單成立已付款
若為 10200095 時，代表消費者未選擇付款方式，故交易失敗。
ItemName
String(200)		商品名稱
CustomField1
String(50)		自訂名稱欄位 1提供合作廠商使用記錄用客製化使用欄位
CustomField2
String(50)		自訂名稱欄位 2提供合作廠商使用記錄用客製化使用欄位
CustomField3
String(50)		自訂名稱欄位 3提供合作廠商使用記錄用客製化使用欄位
CustomField4
String(50)		自訂名稱欄位 4提供合作廠商使用記錄用客製化使用欄位
CheckMacValue
String		檢查碼特店必須檢查檢查碼 [CheckMacValue] 來驗證，請參考附錄檢查碼機制。

查詢信用卡單筆明細記錄 ​

應用場景 ​

提供特店查詢訂單信用卡單筆明細記錄。

介接路徑 ​

特店傳入參數說明 (名稱前若有紅色星號*為必填欄位)： ​

  • Content Type：：application/x-www-form-urlencoded
  • HTTP Method：POST
參數/型態參數名稱說明
*MerchantID
String(10)		特店編號(由歐買尬金流提供)
*CreditRefundId
Int		信用卡授權單號建立訂單時，將參數 [NeedExtraPaidInfo] 設定為「Ｙ」，即可透過付款結果通知取得此參數 (CreditRefundId=gwsr) 資料。
*CreditAmount
Int		金額
*CreditCheckCode
Int		商家檢查碼在廠商後台 → 信用卡收單 → 信用卡授權資訊中可查到
*CheckMacValue
String		檢查碼請參考附錄檢查碼機制

歐買尬金流回傳參數說明： ​

查詢結果會直接回傳至頁面，並以JSON格式表示。

回傳範例（為方便說明，以下的回傳範例經過排版）：

JSON
{ 
    "RtnMsg":"", 
    "RtnValue":{ 
        "TradeID":"0015625112", 
        "amount":"1", 
        "clsamt":"1", 
        "authtime":"2016/5/12 下午 07:09:17", 
        "status":"已關帳", 
        "close_data":[ 
            { 
            "status":"已關帳", 
            "sno":"2782343", 
            "amount":"1", 
            "datetime":"2016/5/12 下午 08:00:00" 
            } 
        ] 
    } 
}


回傳的JSON可分為「（一）主要交易資訊」、「（二）明細資訊」二部分。
以上述範例資料分別說明如下：

（一）主要授權資訊：

json
"RtnMsg":"", 
"RtnValue":{ 
    "TradeID":"0015625112",
    "amount":"100", 
    "clsamt":"100", 
    "authtime":"2016/5/12 下午 07:09:17", 
    "status":"已關帳", 
}

主要授權資訊之參數說明：

參數/型態參數名稱說明
RtnMsg
String(200)		回應訊息若成功回傳空值其餘則為失敗若查無商家或商家己到期，回傳值為： error_Stop
若查無該筆交易授權單號時，回傳值為： error_nopay
若發生錯誤或資料檢核失敗，則回傳值為： error
RtnValue
String		回應內容Json 字串若回傳空值則為查詢失敗
TradeID
Int		授權單號
amount
Int		交易金額
clsamt
Int		已關帳金額
authtime
String(24)		訂單成立時間
status
String(30)		交易狀態若未有關帳明細交易，狀態回傳值如下：
已取消：此筆交易已取消
未授權：銀行未授權完成
已授權：銀行已完成授權
若已有關帳明細交易，狀態回傳值如下：
銀行拒絕
要關帳
關帳中
已關帳
要取消
取消中
已取消
銀行追回中
銀行已追回
批次失敗
不明
操作取消

（二）明細資訊：

json
"close_data":[ 
   { 
   "status":"已關帳", 
   "sno":"2782343", 
   "amount":"100", 
   "datetime":"2016/5/12 下午 08:00:00" 
   } 
  ]

明細資訊之參數說明：

參數/型態參數名稱說明
status
String(30)		交易狀態交易狀態回傳值如下：
銀行拒絕
要關帳
關帳中
已關帳
要取消
取消中
已取消
銀行追回中
銀行已追回
批次失敗
不明
操作取消
amount
Int		交易金額
sno
String(30)		關帳序號
datetime
String(24)		關帳時間