API介接網址
- 測試環境：因無法提供實際授權，故無法使用此API
- 正式環境：https://payment.ecpay.com.tw/CreditDetail/QueryTrade/V2
HTTPS 傳輸協定
- Content Type ：application/x-www-form-urlencoded
- HTTP Method ：POST
特店傳入參數說明
MerchantID String(10)
特店編號(由綠界提供) 必填
CreditRefundId Int
信用卡授權單號 必填
建立訂單時，將參數[NeedExtraPaidInfo]設定為 Y，即可透過付款結果通知取得此參數(CreditRefundId=gwsr)資料。
CreditAmount Int
金額 必填
CreditCheckCode Int
商家檢查碼 必填
廠商後台->信用卡收單->信用卡授權資訊中可查到。
CheckMacValue String
檢查碼 必填
將收到的參數和參數值，加上特店的HashKey&HashIV所產生，請參考附錄檢查碼機制。
注意事項：
- 若未收到付款結果通知時，您可以使用特店交易編號（MerchantTradeNo）呼叫站內付信用卡明細查詢API，來查詢信用卡授權結果。
綠界回傳參數說明
RtnMsg String(200)
回應訊息
- 若成功回傳空值其餘則為失敗
- 若查無商家或商家己到期，回傳值為： error_Stop
- 若查無該筆交易授權單號時，回傳值為： error_nopay
- 若發生錯誤或資料檢核失敗，則回傳值為： error
RtnValue json
回應內容
若回傳空值則為查詢失敗
TradeID Int
授權單號
amount Int
交易金額
clsamt Int
已關帳金額
authtime String(24)
訂單成立時間
status String(30)
交易狀態
若未有關帳明細交易，狀態回傳值如下：
- 已取消：此筆交易已取消
- 未授權：銀行未授權完成
- 已授權：銀行已完成授權
若已有關帳明細交易，狀態回傳值如下：
- 已關帳：此筆交易已完成關帳
- 已取消：此筆交易已取消
- 操作取消：此筆交易已取消關帳
close_data json
關帳明細
內容請參考關帳明細參數說
close_data json
關帳明細
status String(30)
狀態
狀態回傳值如下：
- 要關帳
- 已關帳
- 已取消
- 操作取消
amount Int
交易金額
sno String(30)
關帳序號
datetime String(24)
關帳時間
綠界回傳參數範例
{
"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"
}
]
}
}
YAML
提供的 YAML 文件用於定義 API 的配置、結構、操作和基礎設施管理等資訊，方便開發人員理解和使用 API。
openapi: 3.1.0
info:
title: ECPay Credit Card Transaction Detail Query API
version: 1.0.0
servers:
- url: https://payment.ecpay.com.tw
description: Production Environment
paths:
/CreditDetail/QueryTrade/V2:
post:
summary: Query credit card transaction details
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
MerchantID:
type: string
description: Merchant ID provided by ECPay
CreditRefundId:
type: integer
description: Credit card authorization number
CreditAmount:
type: integer
description: Transaction amount
CreditCheckCode:
type: integer
description: Merchant check code
CheckMacValue:
type: string
description: CheckMac value for verification
required:
- MerchantID
- CreditRefundId
- CreditAmount
- CreditCheckCode
- CheckMacValue
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
RtnMsg:
type: string
description: Response message
RtnValue:
type: object
properties:
TradeID:
type: integer
description: Authorization number
amount:
type: integer
description: Transaction amount
clsamt:
type: integer
description: Amount closed
authtime:
type: string
description: Order creation time
status:
type: string
description: Transaction status
close_data:
type: array
items:
type: object
properties:
status:
type: string
description: Status of the close transaction
sno:
type: string
description: Close transaction serial number
amount:
type: integer
description: Close transaction amount
datetime:
type: string
description: Close transaction time