應用場景
提供查詢信用卡定期定額明細記錄。
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": "123486456"
}
綠界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)
訂單成立時間
格式為 yyyy/MM/dd HH:mm:ss
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
金額
Eci Int
3D(VBV) 回傳值
Eci=5,6,2,1 代表該筆交易為3D交易
Card6No String(6)
信用卡卡號前六碼
Card4No String(4)
信用卡卡號末四碼
PeriodType String(1)
週期種類
訂單設定的週期種類
Frequency Int
執行頻率
訂單設定的執行頻率
ExecTimes Int
執行次數
訂單設定的執行次數
PeriodAmount Int
訂單建立時的每次要授權金額
訂單設定每次要授權金額
TotalSuccessTimes Int
目前已成功授權的次數
目前已成功授權的次數
TotalSuccessAmount Int
目前已成功授權的金額合計
已成功授權總金額
IssuingBank String(30)
銀行名稱
IssuingBankCode String(10)
銀行代碼
ExecStatus String(1)
執行狀態
- 0 : 已取消
- 1 : 執行中
- 2 : 執行完成
ExecLog Array[Object]
每次授權明細
每一次的授權紀錄。例如，若已成功授權3次(TotalSuccessTimes為 3 )，則會顯示3筆授權紀錄。
RtnCode Int
交易狀態
若回傳值時為1時代表授權成功，其餘為失敗，失敗代碼請參考交易訊息代碼一覽表
Amount Int
授權金額
Gwsr Int
授權交易單號
ProcessDate String(20)
授權成功處理時間
格式為 yyyy/MM/dd HH:mm:ss
AuthCode String(6)
授權碼
TradeNo String(20)
綠界的交易編號
ChargeFee Number
手續費
格式為整數8位，小數2位
CustomField String(200)
自訂欄位
提供特店使用客制化欄位
Data參數範例(Json格式)
{
"RtnCode": 1,
"RtnMsg": "Success",
"MerchantID": "3002607",
"OrderInfo": {
"MerchantTradeNo": "20180914001",
"TradeNo": "1809261503338172",
"PaymentDate" :"2018/09/26 14:59:54",
"TradeAmt" :500,
"PaymentType" :"Credit",
"TradeDate" :"2018/09/26 14:59:54",
"ChargeFee" :10,
"TradeStatus" :"1"
},
"CardInfo": {
"AuthCode": "777777",
"Gwsr": 10735183,
"ProcessDate": "2018/09/26 14:59:54",
"Amount": 100,
"Eci": 2,
"Card4No": "2222",
"Card6No": "491122",
"PeriodType": "2",
"Frequency": 2,
"ExecTimes": 1,
"PeriodAmount": 2,
"TotalSuccessTimes": 3,
"TotalSuccessAmount": 5
},
"ExecStatus": "1",
"ExecLog": {
"RtnCode": 1,
"Amount": 500,
"Gwsr": "12345",
"ProcessDate": "2020/12/31 15:12:20",
"AuthCode": "123456",
"TradeNo": "12345649781",
"ChargeFee" : 10
}
}