應用場景
買方/賣方於發票開立後發生銷貨退回、調換貨物或折讓等情事，但開立折讓單後，發生內容開立錯誤而進行作廢折讓，特店(營業人)收到作廢折讓訊息通知後，傳送作廢折讓確認參數給綠界科技加值中心(以下簡稱綠界)，由綠界暫存相關資料。綠界於隔日將此作廢折讓確認訊息上傳至財政部電子發票整合服務平台，完成發票作廢折讓交換。並根據發送通知API設定，通知交易相對人(營業人)電子發票作廢折讓已完成確認。
API介接網址
- 測試環境：https://einvoice-stage.ecpay.com.tw/B2BInvoice/CancelAllowanceConfirm
- 正式環境：https://einvoice.ecpay.com.tw/B2BInvoice/CancelAllowanceConfirm
特店Request參數說明 (Json格式)
PlatformID String(10)
特約合作平台商代號
- 提供特約合作平台商向綠界申請開通後使用，一般廠商介接請放空值。
- 平台商使用時，MerchantID(特店編號)欄位僅限帶入已綁定子廠商的特店編號，以免造成失敗。
MerchantID String(10)
特店編號 必填
RqHeader Object
傳入資料 必填
Timestamp Number
傳入時間 必填
綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間
注意事項：
- 驗證時間區間暫訂為 10 分鐘內有效，若超過此驗證時間則此次訂單將無法建立，參考資料：http://www.epochconverter.com/。
- 合作特店須進行主機「時間校正」，避免主機產生時差，導致API無法正常運作。
Data String
加密資料 必填
此為加密過JSON格式的資料。加密方法說明
特店Request參數範例 (Json格式)
{
"MerchantID": "2000132",
"RqHeader": {
"Timestamp": 1234567890
},
"Data": "…"
}
Data參數說明(Json格式)
MerchantID String(10)
特店編號 必填
AllowanceNo String(16)
綠界折讓編號 必填
長度固定為16碼
Remark String(200)
備註
Data參數範例(Json格式)
{
"MerchantID": "2000132",
"AllowanceNo": "1909241702402030",
"Remark": "Cancel_Allowance_Reamrk"
}
綠界Response參數說明 (Json格式)
PlatformID String(10)
特約合作平台商代號
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 為成功，其餘為失敗
RtnMsg String(200)
回應訊息
Data參數範例(Json格式)
{
"RtnCode": 1,
"RtnMsg": "新增成功"
}