應用場景
特店系統可使用此API查詢已作廢的發票資訊
API介接網址
- 測試環境:https://einvoice-stage.ecpay.com.tw/B2CInvoice/GetInvalid
- 正式環境:https://einvoice.ecpay.com.tw/B2CInvoice/GetInvalid
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)
特店編號 必填
RelateNumber String(30)
特店自訂編號 必填
需為唯一值不可重複使用
注意事項:請勿使用特殊符號
InvoiceNo String(10)
發票號碼 必填
InvoiceDate String(10)
發票開立日期 必填
格式為「yyyy-MM-dd」或 「yyyy/MM/dd」
Data參數範例(Json格式)
{
"MerchantID": 2000132,
"RelateNumber": "123456789",
"InvoiceNo": "UV11100016",
"InvoiceDate": "2018-10-28"
}
綠界回傳參數格式
- 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)
回應訊息
ChannelPartner String(1)
通路商編號
1:蝦皮
IIS_Mer_ID String(10)
特店編號
II_Invoice_No String(10)
發票號碼
II_Date String(20)
作廢時間
格式為「yyyy-MM-dd HH:mm:ss」
II_Upload_Status String(1)
上傳狀態
1:已上傳
0:未上傳
II_Upload_Date String(20)
上傳時間
格式為「yyyy-MM-dd HH:mm:ss」
Reason String(20)
作廢原因
II_Seller_Identifier String(10)
賣方統編
II_Buyer_Identifier String(10)
買方統編
0000000000代表沒有統編
Data參數範例
{
"RtnCode": 1,
"RtnMsg": "查詢成功",
"ChannelPartner": "",
"IIS_Mer_ID": "2000132",
"II_Invoice_No": "UV11100018",
"II_Date": "2019-09-17 20:00:50",
"II_Upload_Status": "0",
"II_Upload_Date": "",
"Reason": "Invalid_Reason",
"II_Seller_Identifier": "11456006",
"II_Buyer_Identifier": "0000000000"
}
YAML
提供的 YAML 文件用於定義 API 的配置、結構、操作和基礎設施管理等資訊,方便開發人員理解和使用 API。
openapi: 3.1.0
info:
title: ECPay Query Invalid Invoice Details API
version: 1.0.0
servers:
- url: https://einvoice-stage.ecpay.com.tw
description: Testing Environment
- url: https://einvoice.ecpay.com.tw
description: Production Environment
paths:
/B2CInvoice/GetInvalid:
post:
summary: Query Invalid Invoice Details
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- MerchantID
- RqHeader
- Data
properties:
PlatformID:
type: string
maxLength: 10
description: Platform ID for partnered platforms
MerchantID:
type: string
maxLength: 10
description: Merchant ID
RqHeader:
type: object
required:
- Timestamp
properties:
Timestamp:
type: integer
description: Unix timestamp (GMT+8)
Data:
type: string
description: Encrypted data containing request details
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
properties:
PlatformID:
type: string
maxLength: 10
description: Platform ID for partnered platforms
MerchantID:
type: string
maxLength: 10
description: Merchant ID
RpHeader:
type: object
properties:
Timestamp:
type: integer
description: Unix timestamp (GMT+8)
TransCode:
type: integer
description: Transmission code
TransMsg:
type: string
maxLength: 200
description: Transmission message
Data:
type: string
description: Encrypted data containing response details
components:
schemas:
requestBody.Data:
type: object
required:
- MerchantID
- RelateNumber
- InvoiceNo
- InvoiceDate
properties:
MerchantID:
type: string
maxLength: 10
description: Merchant ID
RelateNumber:
type: string
maxLength: 30
description: Merchant-defined unique number
InvoiceNo:
type: string
maxLength: 10
description: Invoice number
InvoiceDate:
type: string
description: Invoice issue date in 'yyyy-MM-dd' or 'yyyy/MM/dd' format
responses.Data:
type: object
properties:
RtnCode:
type: integer
description: Response code
RtnMsg:
type: string
maxLength: 200
description: Response message
ChannelPartner:
type: string
maxLength: 1
description: Channel partner ID
IIS_Mer_ID:
type: string
maxLength: 10
description: Merchant ID
II_Invoice_No:
type: string
maxLength: 10
description: Invoice number
II_Date:
type: string
description: Invalid date in 'yyyy-MM-dd HH:mm:ss' format
II_Upload_Status:
type: string
maxLength: 1
description: Upload status
II_Upload_Date:
type: string
description: Upload date in 'yyyy-MM-dd HH:mm:ss' format
Reason:
type: string
maxLength: 20
description: Invalid reason
II_Seller_Identifier:
type: string
maxLength: 10
description: Seller identifier
II_Buyer_Identifier:
type: string
maxLength: 10
description: Buyer identifier