應用場景
API介接網址
- 測試環境：https://einvoice-stage.ecpay.com.tw/B2BInvoice/Notify
- 正式環境：https://einvoice.ecpay.com.tw/B2BInvoice/Notify
注意事項：測試環境下綠界不會『主動』發送任何通知，需於廠商管理後台使用『補發通知』，才會寄送通知信到指定信箱。
特店Request參數說明 (Json格式)
PlatformID String(10)
特約合作平台商代號
- 提供特約合作平台商向綠界申請開通後使用，一般廠商介接請放空值。
- 平台商使用時，MerchantID(特店編號)欄位僅限帶入已綁定子廠商的特店編號，以免造成失敗。
MerchantID String(10)
特店編號 必填
RqHeader Object
傳輸資料 必填
Timestamp String(10)
傳入時間 必填
綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間
注意事項：
- 驗證時間區間暫訂為10分鐘內有效，若超過此驗證時間則此次訂單將無法建立
參考資料：http://www.epochconverter.com/。 - 合作特店須進行主機「時間校正」，避免主機產生時差，延伸API無法正常運作。
Data String
加密資料 必填
回傳相關資料，此為加密過JSON格式的資料。加密方法說明
特店Request參數範例 (Json格式)
{
"MerchantID": "2000132",
"RqHeader": {
"Timestamp": 1234567890
},
"Data": "…"
}
Data參數說明(Json格式)
注意事項：請在加密前對參數值進行 URLEncode
MerchantID String(10)
特店編號 必填
InvoiceDate String(20)
發票開立日期 必填
格式為 yyyy-mm-dd
InvoiceNumber String(10)
發票號碼 必填
AllowanceNo String(16)
折讓單編號
NotifyMail String(200)
發送電子郵件 必填
- 僅接受Email的標準格式
- 可輸入多組，以半形分號(;)區隔
InvoiceTag String(1)
發送內容類型 必填
- 1：發票開立
- 2：發票作廢
- 3：發票退回
- 4：開立折讓
- 5：作廢折讓
- 6：開立發票確認
- 7：作廢發票確認
- 8：退回發票確認
- 9：折讓確認
- 10：作廢折讓確認
Notified String(1)
發送對象 必填
- C：發送通知給客戶
- M：發送通知給合作特店
- A：皆發送通知
Data參數範例 (Json格式)
{
"MerchantID": "2000132",
"InvoiceDate": "2019-09-04",
" InvoiceNumber": "VG11000000",
" NotifyMail": "abc5678@gmail.com; def5678@gmail.com ",
" InvoiceTag": 1,
" Notified": "C"
}
綠界Response參數說明 (Json格式)
PlatformID String(10)
特約合作平台商代號
MerchantID String(10)
特店編號
RpHeader Object
回傳資料
Timestamp String(10)
回傳時間
時間戳 Unix timestamp
TransCode Int
回傳代碼
1 代表 API 傳輸資料 (MerchantID, RqHeader, Data) 接收成功，實際的API執行結果狀態請參考 RtnCode 參數
TransMsg String(200)
回傳訊息
Data String
加密資料
此參數為加密過的 JSON 格式資料。加密方法說明
綠界Response參數範例 (Json格式)
{
"MerchantID": "2000132",
"RpHeader": {
"Timestamp": "1525169058"
},
"TransCode": 1,
"TransMsg": "",
"Data": "…"
}
Data參數說明(Json格式)
RtnCode Int
回應代碼
1 為成功，其餘為失敗
RtnMsg String(200)
回應訊息
Data參數範例(Json格式)
{
"RtnCode": 1,
"RtnMsg": "發送完成"
}