Skip to content

查詢訂單

查詢訂單

應用場景

提供廠商查詢訂單資訊,可透過此 API 來過濾是否為有效訂單。

介接路徑

廠商傳入參數說明:(JSON 格式,名稱前若有紅色星號*必填欄位):

  • Content Type:application/json
  • HTTP Method:POST
參數 / 型態參數名稱說明
*MerchantID
String(10)
特店編號請填入由歐買尬金流提供的特店編號
*RqHeader
JSON
傳輸資料 
*Timestamp
Number
傳輸時間時間戳 Unix timestamp

※注意事項:
若時間戳跟歐買尬金流伺服器接收到時間超過 10 分鐘時,交易會失敗無法進行
*Revision
String(10)
串接版號請參考 系統介接測試相關資訊的串接版號。 例:1.0.0
*Data
String
加密資料加密過 JSON 格式的資料。加密方法說明

範例

json
{
    "MerchantID": "1000031", 
    "RqHeader": 
    {
        "Timestamp": 1234567890,
        "Revision": "1.0.0"
    },
    "Data": "…"
}

#### Data參數說明:請在加密前對參數值進行 URLEncode

參數 / 型態參數名稱說明
PlatformID
String(10)
特約合作平台商代號為專案合作的平台商使用。此參數請帶空值。
*MerchantID
String(10)
特店編號 
*MerchantTradeNo
String(20)
特店交易編號 

Data範例

json
{
    "MerchantID": "1000031",
    "MerchantTradeNo": "20180914001"
}

歐買尬金流回傳參數說明:(JSON 格式)

參數 / 型態參數名稱說明
MerchantID
String(10)
特店編號 
RqHeader
JSON
傳輸資料 
Timestamp
Number
傳輸時間時間戳 Unix timestamp
TransCode
Int
回傳代碼1 代表傳輸資料(MerchantID,RqHeader,Data)接收成功,其餘均為失敗
TransMsg
String(200)
回傳訊息回傳訊息
Data
String
加密資料加密過 JSON 格式的資料。加密方法說明

範例

json
{
    "MerchantID": "1000031", 
    "RpHeader": 
    {
        "Timestamp": 1234564848
    },
    "TransCode": 1,
    "TransMsg": "Success",
    "Data": "…"
}

Data參數說明:請在解密後對參數值進行 URLDecode

參數 / 型態參數名稱說明
RtnCode
Int
交易狀態1 代表 API 執行成功,其餘代碼均為失敗。
失敗代碼請參考交易訊息代碼表
RtnMsg
String(200)
回應訊息 
以下為 RtnCode 為 1 時才會回傳  
PlatformID
String(10)
平台商編號特約合作平台商特店編號。
MerchantID
String(10)
特店編號 
OrderInfo
JSON Object
訂單資訊 
MerchantTradeNo
String(20)
特店交易編號不可重複
TradeNo
String(20)
歐買尬金流的交易編號 
TradeAmt
Int
交易金額 
TradeDate
String(20)
訂單成立時間yyyy/MM/dd HH:mm:ss
PaymentType
String(20)
特店選擇的付款方式 
PaymentDate
String(20)
付款時間格式為 yyyy/MM/dd HH:mm:ss
ChargeFee
Number
手續費 
TradeStatus
String(8)
交易狀態若為 0 時,代表交易訂單付款失敗。
若為 1 時,代表交易訂單付款成功。
CVSInfo
JSON Object
CVS 資訊 
PayFrom
String(10)
繳費超商family:全家
ibon:7-11
PaymentNo
String(14)
繳費代碼 
PaymentURL
String(100)
繳費連結 
StoreID
String(20)
超商代碼繳款的店舖代號020328
StoreName
String(20)
超商代碼繳款的店舖名稱台中公民店
ATMInfo
JSON Object
ATM 資訊 
ATMAccBank
String(3)
付款人銀行代碼 
ATMAccNo
String(5)
付款人銀行帳號後五碼 
CardInfo
JSON 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
紅利扣點使用信用卡紅利時回傳
RedDeAmt
Int
紅利折抵金額使用信用卡紅利時回傳
RedOkAmt
Int
實際扣款金額使用信用卡紅利時回傳
RedYet
Int
紅利剩餘點數使用信用卡紅利時回傳
PeriodType
String (1)
週期種類定期定額時回傳,訂單建立時所設定的週期種類
Frequency
Int
執行頻率定期定額時回傳,訂單建立時所設定的執行頻率
ExecTimes
Int
執行次數定期定額時回傳,訂單建立時所設定的執行頻率
PeriodAmount
Int
每次要授權金額定期定額時回傳
TotalSuccessTimes
Int
目前已成功授權的次數定期定額時回傳,目前已成功授權的次數。
TotalSuccessAmount
Int
目前已成功授權的金額合計定期定額時回傳
CustomField
String(200)
自訂欄位提供特店使用客制化欄位

#### Data範例(解密後)

json
{
    "RtnCode": 1,
    "RtnMsg": "Success",
    "MerchantID": "1000031",
    "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": "431195",
        "RedDan": 0,
        "RedOkAmt": 0,
        "RedYet": 0
    }
}

查詢信用卡單筆明細記錄(Server)

應用場景

提供查詢信用卡明細記錄。

介接路徑

廠商傳入參數說明:(JSON 格式,名稱前若有紅色星號*必填欄位):

  • Content Type:application/json
  • HTTP Method:POST
參數 / 型態參數名稱說明
*MerchantID
String(10)
特店編號請填入由歐買尬金流提供的特店編號
*RqHeader
JSON
傳輸資料 
*Timestamp
Number
傳輸時間時間戳 Unix timestamp

※注意事項:
若時間戳跟歐買尬金流伺服器接收到時間超過 10 分鐘時,交易會失敗無法進行
*Revision
String(10)
串接版號請參考 系統介接測試相關資訊的串接版號。 例:1.0.0
*Data
String
加密資料加密過 JSON 格式的資料。加密方法說明

範例

json
{
    "MerchantID": "1000031", 
    "RqHeader": 
    {
        "Timestamp": 1234567890,
        "Revision": "1.0.0"
    },
    "Data": "…"
}

Data參數說明:請在加密前對參數值進行 URLEncode

參數 / 型態參數名稱說明
PlatformID
String(10)
特約合作平台商代號為專案合作的平台商使用。此參數請帶空值。
*MerchantID
String(10)
特店編號 
*MerchantTradeNo
String(20)
特店交易編號 
TradeNo
String(20)
歐買尬金流交易編號此欄位可從定期定額訂單查詢 API 取得。可查詢定期定額第一筆之後的授權資料內容。
json
{
    "MerchantID": "1000031",
    "MerchantTradeNo": "20180914001"
}

歐買尬金流回傳參數說明:(JSON 格式)

參數 / 型態參數名稱說明
MerchantID
String(10)
特店編號 
RqHeader
JSON
傳輸資料 
Timestamp
Number
傳輸時間時間戳 Unix timestamp

※注意事項:
若時間戳跟歐買尬金流伺服器接收到時間超過 10 分鐘時,交易會失敗無法進行。
TransCode
Int
回傳代碼1 代表傳輸資料(MerchantID,RqHeader,Data)接收成功,其餘均為失敗。
TransMsg
String(200)
回傳訊息回傳訊息
Data
String
加密資料加密過 JSON 格式的資料。加密方法說明

範例

json
{
    "MerchantID": "1000031", 
    "RpHeader": 
    {
        "Timestamp": 1234564848
    },
    "TransCode": 1,
    "TransMsg": "Success",
    "Data": "…"
}

Data參數說明:請在解密後後對參數值進行 URLDecode

參數 / 型態參數名稱說明
RtnMsg
String(200)
回應訊息若成功回傳空值其餘則為失敗
RtnValue
JSON
回應資料RtnMsg 為空值時才會回傳
RtnValue 回應內容
TradeID
Int
授權單號 
Amount
Int
交易金額 
ClsAmt
Int
已關帳金額 
AuthTime
String(24)
訂單成立時間 
Status
String(30)
交易狀態● 若未有關帳明細交易,狀態回傳值如下:
已取消(Canceled):此筆交易已取消
未授權(Unauthorized):銀行未授權完成
已授權(Authorized):銀行已完成授權

● 若已有關帳明細交易,狀態回傳值如下:
銀行拒絕(Bank Refused)
要關帳(To be captured)
關帳中(Captured in progress)
已關帳(Captured)
要取消(To be canceled)
取消中(Canceled in progress)
銀行追回中(Bank chargebacked in progress)
銀行已追回(Bank chargebacked)
不明(Unknown)
操作取消(Operation canceled)
CloseData
Array
交易明細 
Status
String(30)
狀態狀態回傳值如下:
銀行拒絕(Bank Refused)
取消中(Canceled in progress)
銀行追回中(Bank chargebacked in progress)
銀行已追回(Bank chargebacked)
批次失敗(Batch failured)
不明(Unknown)
操作取消(Operation canceled)
Amount
Int
交易金額 
DateTime
String(24)
關帳時間 

Data(解密後)

json
{
    "RtnMsg": "",
    "RtnValue": 
    {
        "TradeID": 10735183,
        "Amount": 100,
        "ClsAmt" : 100,
        "AuthTime" :"2018/09/26 14:59:54",
        "Status" :"To be captured"
    },
    "CloseData": 
    [{
        "Status": "Bank chargebacked ",
        "Amount": 100,
        "DateTime" :"2018/09/26 14:59:54"
    }]
}