應用場景
特店可使用此API查詢字軌號碼以及字軌的使用情況。
API介接網址
- 正式環境：https://einvoice.ecpay.com.tw/B2CInvoice/GetInvoiceWordSetting
- 測試環境：https://einvoice-stage.ecpay.com.tw/B2CInvoice/GetInvoiceWordSetting
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格式)
{
"MerchantID": "2000132",
"RqHeader": {
"Timestamp": "1525168923",
"Revision": "1.0.0"
},
"Data": "加密資料"
}
Data參數說明(Json格式)
MerchantID String(10)
特店編號 必填
InvoiceYear String(3)
發票年度 必填
InvoiceTerm Int
發票期別 必填
不可帶入小於當年期別
- 0: 全部
- 1: 1-2月
- 2: 3-4月
- 3: 5-6月
- 4: 7-8月
- 5: 9-10月
- 6: 11-12月
UseStatus Int
發票字軌狀態 必填
- 0:全部
- 1:未啟用
- 2:使用中
- 3:已停用
- 4:暫停中
- 5:待審核
- 6:審核不通過
InvoiceCategory Int
發票類別 必填
InvType String(2)
字軌類別
- 07:一般稅額發票
- 08:特種稅額發票
InvoiceHeader String(2)
發票字軌
Data參數範例(Json格式)
{
"MerchantID": "2000132",
"InvoiceTerm": 0,
"InvoiceYear": "109",
"UseStatus": 1,
"InvoiceCategory": 4
}
綠界回傳參數(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
加密資料
綠界回傳參數範例
{
"MerchantID": "2000132",
"RpHeader": {
"Timestamp": "1525169058"
},
"TransCode": 1,
"TransMsg": "",
"Data": "加密資料"
}
Data參數(Json格式)
RtnCode Int
回應代碼
1 代表 API 執行成功，其餘代碼均為失敗，失敗代碼請參考交易訊息代碼表。
RtnMsg String(200)
回應訊息
InvoiceInfo Array[Object]
發票資訊
TrackID String(10)
字軌號碼ID
InvoiceYear String(3)
發票年度
InvoiceTerm Int
發票期別
- 1: 1-2月
- 2: 3-4月
- 3: 5-6月
- 4: 7-8月
- 5: 9-10月
- 6: 11-12月
InvoiceCategory Int
發票類別
4:離線發票
InvType String(2)
字軌類別
- 07:一般稅額發票
- 08:特種稅額發票
InvoiceHeader String(2)
發票字軌
InvoiceStart String(8)
起始發票編號
InvoiceEnd String(8)
結束發票編號
InvoiceNo String(8)
目前已使用號碼號
UseStatus Int
使用狀態
- 1:未啟用
- 2:使用中
- 3:已停用
- 4:暫停中
- 5:待審核
- 6:審核不通過
發票機台ID String(10)
發票機台ID
回傳Data參數範例
{
"RtnCode": 1,
"RtnMsg": "查詢成功"
"InvoiceInfo": [
{
"TrackID": "1234567890",
"InvoiceYear": "109",
"InvoiceTerm": 1,
"InvoiceCategory": 4,
"InvType": "07",
"InvoiceHeader": "AQ",
"InvoiceStart": "10000000",
"InvoiceEnd": "19999999",
"InvoiceNo": "12345678",
"UseStatus": 2,
"MachineID": "12345678"
},{
"TrackID": "1234569870",
"InvoiceYear": "109",
"InvoiceTerm": 1,
"InvoiceCategory": 4,
"InvType": "07",
"InvoiceHeader": "AQ",
"InvoiceStart": "10000000",
"InvoiceEnd": "19999999",
"InvoiceNo": "12345678",
"UseStatus": 2,
"MachineID": "12345688"
}
]
}