應用場景
提供廠商下載CSV格式的信用卡撥款對帳檔內容,包含請/退款紀錄的付款資訊。
- Step 1. 廠商系統:將要查詢的信用卡撥款資料條件,以POST(HTTP Method)傳送至綠界,進行查詢。
- Step 2. 綠界:接受信用卡撥款查詢並檢核資料後,回傳CSV檔案格式提供廠商系統下載。
注意事項:
- 此API有限制 IP 存取,請到「廠商後台->系統開發管理->系統介接設定->介接設定」設定 IP 。
- 同IP僅開放一分鐘下載一個對帳資料檔 。
- 請廠商每日進行信用卡撥款對帳查詢,確認撥款資料符合交易付款結果。
API介接網址
- 測試環境:因無法提供實際授權,故無法使用此API
- 正式環境:https://payment.ecPay.com.tw/CreditDetail/FundingReconDetail
HTTPS 傳輸協定
- Content Type :application/x-www-form-urlencoded
- HTTP Method :POST
特店傳入參數說明
MerchantID String(10)
特店編號(由綠界提供) 必填
PayDateType String(10)
查詢日期類別 必填
可依據不同日期類別參數查詢撥款訂單:
- fund:依交易款項結算日期
- close:依操作關帳或自動關帳日期
- enter:依撥款至特店綠界帳戶日期
注意事項:
- 結算日期:交易款項結算至信託專戶的日期,關帳後次一個工作日。
- 關帳日期:您於後台操作關帳或系統自動關帳執行日期,綠界系統將於關帳後向銀行請款。
- 撥款入帳日期:結算日期加上您的撥款天期,即為款項撥入您綠界帳戶的日期;若為退刷交易,會先圈存後,於撥款入帳日期實際扣除。
StartDate String(10)
查詢開始日期 必填
要查詢的開始日期
日期格式為「yyyy-MM-dd」
注意事項:搜尋日期必須為銀行上班日的14:00之後才能查到資料。
Ex: 1/16、1/17為銀行休假日,1/18的14:00之後才能查到1/15~1/17的資料;搜尋日期必須是1/18
EndDate String(10)
查詢結束日期 必填
要查詢的結束日期
日期格式為「yyyy-MM-dd」
CharSet String(1)
檔案編碼格式 非必填
要下載的檔案編碼格式
- 若為Big5格式時,則參數請帶1
- 若為UTF8格式時,則參數請帶2
- 若未傳入此參數或為空值時,預設為Server Default編碼格式
CheckMacValue String
檢查碼 必填
請參考附錄檢查碼機制
綠界回傳CSV檔案格式說明
授權單號
授權碼
關帳單號
訂單編號
交易日期
格式為yyyyMMdd
請款日期
格式為yyyyMMdd
交易金額
若為退款時,此金額會為負數。
手續費
%數
撥款金額
注意事項:今日訂單需於隔日的14:00過後方可查到訂單信用卡撥款資訊,信用卡撥款需於銀行工作日時才會進行撥款,假日或非工作日時不會有撥款資訊。
YAML
提供的 YAML 文件用於定義 API 的配置、結構、操作和基礎設施管理等資訊,方便開發人員理解和使用 API。
openapi: 3.1.0
info:
title: ECPay Credit Card Disbursement Reconciliation API
version: 1.0.0
description: API for downloading CSV files of credit card disbursement reconciliation details.
servers:
- url: https://payment.ecpay.com.tw
description: Production Environment
paths:
/CreditDetail/FundingReconDetail:
post:
summary: Download credit card disbursement reconciliation file
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
MerchantID:
type: string
description: Merchant ID provided by ECPay
PayDateType:
type: string
description: Date type for query
enum:
- fund
- close
- enter
StartDate:
type: string
description: Start date of the query (yyyy-MM-dd)
EndDate:
type: string
description: End date of the query (yyyy-MM-dd)
CharSet:
type: string
description: File encoding format
enum:
- 1
- 2
CheckMacValue:
type: string
description: CheckMacValue for data verification
required:
- MerchantID
- PayDateType
- StartDate
- EndDate
- CheckMacValue
responses:
'200':
description: Successful response
content:
text/csv:
schema:
type: string
description: |
CSV 格式如下:
```
授權單號,授權碼,關帳單號,訂單編號,交易日期, 請款日期,交易金額,手續費,%數,撥款金額
```