應用場景
營業人(特店)可使用此功能將已作廢的發票傳送至綠界，由綠界將作廢資料上傳至財政部電子發票整合服務平台。
API介接網址
- 正式環境：https://einvoice.ecpay.com.tw/B2CInvoice/OfflineInvalid
- 測試環境：https://einvoice-stage.ecpay.com.tw/B2CInvoice/OfflineInvalid
HTTPS 傳輸協定
- Content Type ：application/json
- HTTP Method ：POST
特店傳入參數(Json格式)
PlatformID String(10)
特約合作平台商代號
- PlatformID為與綠界有合作專案的特約平台商身分使用。一般特店或賣家身分(Merchant)，或平台商本身，此參數請帶放空值。
- 若隸屬於特約平台商的一般特店，此參數請帶放平台商的MerchantID。
RqHeader Object
傳入資料 必填
Timestamp String(10)
傳入時間
請將傳輸時間轉換為時間戳(GMT+8)，綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。
注意事項：
- 驗證時間區間為 10 分鐘內有效，若超過此驗證時間則此次API request將無法建立，參考資料：http://www.epochconverter.com/。
- 特店需進行主機「時間校正」，避免主機產生時差，造成API request失敗。
Data String
加密資料 必填
回傳相關資料，此為加密過JSON格式的資料。加密方法說明
特店傳入參數範例(Json格式)
{
"MerchantID": "2000132",
"RqHeader": {
"Timestamp": "1525168923",
"Revision": "1.0.0"
},
"Data": "加密資料"
}
Data參數說明(Json格式)
MerchantID String(10)
特店編號 必填
InvoiceNo String(10)
發票號碼 必填
2碼字軌+8碼數字
InvoiceDate String(20)
發票開立日期 必填
yyyy-MM-dd
Reason String(20)
作廢原因 必填
CancelDate String(20)
發票作廢時間 必填
yyyy-MM-dd HH:mm:ss
Data參數範例(Json格式)
{
"MerchantID": "2000132",
"InvoiceNo": "UV11100016",
"InvoiceDate": "2021-01-14",
"Reason": "發票作廢",
"CancelDate": "2021-01-15 15:12:03"
}
綠界回傳參數(Json格式)
PlatformID String(10)
特約合作平台商代號
MerchantID String(10)
特店編號
RpHeader Object
傳入資料
Timestamp String(10)
傳入時間
請將傳輸時間轉換為時間戳(GMT+8)，綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。
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)
回應訊息
InvoiceNo String(10)
發票號碼
若作廢成功，則會回傳發票號碼 若開立失敗，則會回傳空值。
回傳Data參數範例
{
"RtnCode": 1,
"RtnMsg": "成功",
"InvoiceNo": "KK12345678"
}