應用場景
特店可使用此API取得發票列印網址
API介接網址
- 測試環境:https://einvoice-stage.ecpay.com.tw/B2CInvoice/InvoicePrint
- 正式環境:https://einvoice.ecpay.com.tw/B2CInvoice/InvoicePrint
HTTPS傳輸協定
- Content Type :application/json
- HTTP Method :POST
特店傳入參數(Json格式)
PlatformID String(10)
特約合作平台商代號
- 提供特約合作平台商向綠界申請開通後使用,一般廠商介接請放空值。
- 平台商使用時,MerchantID(特店編號)欄位僅限帶入已綁定子廠商的特店編號,以免造成失敗
MerchantID String(10)
特店編號 必填
RqHeader
傳入資料 必填
Timestamp Number
傳入時間 必填
請將傳輸時間轉換為時間戳(GMT+8),綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。
注意事項:
- 驗證時間區間暫訂為 10 分鐘內有效,若超過此驗證時間則此次訂單將無法建立,參考資料:http://www.epochconverter.com/。
- 合作特店須進行主機「時間校正」,避免主機產生時差,導致API無法正常運作。
Data String
加密資料 必填
此為加密過JSON格式的資料。加密方法說明
特店傳入參數範例(Json格式)
{
"MerchantID": "2000132",
"RqHeader": {
"Timestamp": 1525168923
},
"Data": "加密資料"
}
Data參數說明(Json格式)
MerchantID String(10)
特店編號 必填
InvoiceNo String(10)
發票號碼 必填
2碼字軌+8碼數字
InvoiceDate String(20)
發票開立日期 必填
格式為「yyyy-MM-dd」或 「yyyy/MM/dd」
PrintStyle Int
發票列印格式
1:一般列印(單面),預設
2:一般列印(雙面)
3:熱感應紙列印
4:B2B A4(僅限帶有統編的發票才能使用)
5:B2B A5(僅限帶有統編的發票才能使用)
IsShowingDetail Int
是否顯示明細
1:顯示明細
2:隱藏明細
注意事項:
- 帶統編的發票,一律顯示明細,不會參照此參數設定
- 如果未帶此參數,“帶統編”的發票會預設“顯示”明細,“不帶統編”的發票會預設“不顯示”明細
- 發票列印格式[PrintStyle]為B2B A4 或 B2B A5時,一律顯示明細,不會參照此參數設定
Data參數範例(Json格式)
{
"MerchantID": "2000132",
"InvoiceNo": "UV11100016",
"InvoiceDate": "2018-10-28"
}
綠界回傳參數格式
- Content Type :application/json
- HTTP Method :POST
綠界回傳參數(Json格式)
PlatformID String(10)
特約合作平台商代號
MerchantID String(10)
特店編號
RpHeader
回傳資料
Timestamp Number
回傳時間
Unix timestamp(GMT+8)
TransCode Int
回傳代碼
1 代表 API 傳輸資料(MerchantID, RqHeader, Data)接收成功,實際的 API 執行結果狀態請參考 RtnCode。
TransMsg String(200)
回傳訊息
Data String
加密資料
回傳相關資料,此為加密過JSON格式的資料。加密方法說明
綠界回傳參數範例
{
"MerchantID": "2000132",
"RpHeader": {
"Timestamp": 1525169058
},
"TransCode": 1,
"TransMsg": "",
"Data": "加密資料"
}
回傳Data參數說明(Json格式)
RtnCode Int
回應代碼
1 代表 API 執行成功,其餘代碼均為失敗。
RtnMsg String(200)
回應訊息
InvoiceHtml String
發票列印網址
回傳Data參數範例
{
"RtnCode": 1,
"RtnMsg": "成功",
"InvoiceHtml": "https://aa.aa.aa"
}