應用場景
特店系統可使用此API查詢已作廢折讓明細資訊
API介接網址
- 測試環境：https://einvoice-stage.ecpay.com.tw/B2CInvoice/GetAllowanceInvalid
- 正式環境：https://einvoice.ecpay.com.tw/B2CInvoice/GetAllowanceInvalid
HTTPS傳輸協定
- Content Type ：application/json
- HTTP Method ：POST
特店傳入參數(Json格式)
PlatformID String(10)
特約合作平台商代號
- 這個參數是專為與綠界簽約的指定平台商所設計，只有在申請開通後才能使用。
- 如果您是一般廠商，請在介接時將此參數欄位保留為空。
- 對於平台商，在使用時需要在MerchantID(特店編號)欄位中填入與您已經完成綁定子廠商的MerchantID(特定編號)。
請注意，只能使用已綁定的子廠商編號，以避免操作失敗。綁定作業請洽所屬業務。
MerchantID String(10)
特店編號 必填
RqHeader Object
傳入資料 必填
Timestamp Number
傳入時間 必填
請將傳輸時間轉換為時間戳(GMT+8)，綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。
注意事項：
- 驗證時間區間暫訂為 10 分鐘內有效，若超過此驗證時間則此次訂單將無法建立，參考資料：http://www.epochconverter.com/。
- 合作特店須進行主機「時間校正」，避免主機產生時差，導致API無法正常運作。
Data String
加密資料 必填
此為加密過JSON格式的資料。加密方法說明
特店傳入參數範例(Json格式)
{
"MerchantID": "2000132",
"RqHeader": {
"Timestamp": 1525168923
},
"Data": "加密資料"
}
Data參數說明(Json格式) : 請先將Json字串進行urlencode後再進行AES加密
MerchantID String(10)
特店編號 必填
InvoiceNo String(10)
發票號碼 必填
AllowanceNo String(16)
折讓編號 必填
Data參數範例(Json格式)
{
"MerchantID": 2000132,
"InvoiceNo": "UV11100016",
"AllowanceNo": "2019091719477262"
}
綠界回傳參數格式
- Content Type ：application/json
- HTTP Method ：POST
綠界回傳參數(Json格式)
PlatformID String(10)
特約合作平台商代號
MerchantID String(10)
特店編號
RpHeader Object
回傳資料
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格式) : 請先將Data進行AES解密後再做urldecode
RtnCode Int
回應代碼
1 代表 API 執行成功，其餘代碼均為失敗。
RtnMsg String(200)
回應訊息
AI_Allow_Date String(20)
折讓單日期
格式為「yyyy-MM-dd HH:mm:ss」
AI_Allow_No String(16)
折讓單號
AI_Buyer_Identifier String(10)
買方統編
0000000000代表沒有統編
AI_Date String(20)
作廢時間
格式為「yyyy-MM-dd HH:mm:ss」
AI_Invoice_No String(10)
發票號碼
AI_Mer_ID String(10)
特店代號
Reason String(20)
作廢原因
AI_Seller_Identifier String(10)
賣方統編
AI_Upload_Date String(20)
上傳時間
格式為「yyyy-MM-dd HH:mm:ss」
AI_Upload_Status String(1)
上傳狀態
1：已上傳
0：未上傳
Data參數範例
{
"AI_Allow_Date": "2019-09-17 19:47:19",
"AI_Allow_No": "2019091719477262",
"AI_Buyer_Identifier": "0000000000",
"AI_Date": "2019-09-17 19:52:58",
"AI_Invoice_No": "UV11100016",
"AI_Mer_ID": "2000132",
"Reason": "Reson",
"AI_Seller_Identifier": "11456006",
"AI_Upload_Date": "",
"AI_Upload_Status": "0",
"RtnCode": 1,
"RtnMsg": "查詢成功"
}