應用場景
B2B電子發票分為交換與存證模式,在串接此規格文件前,必須先用此API設定交易對象(參數[type])為買方/賣方/買賣方、設定開立形式(參數[ExchangeMode])為交換/存證以及新增交易對象的相關資訊。
注意事項:
同一個統編下若有多個MerchantID,這些MerchantID儘能以「存證」開立方式來建立相同交易對象,即這些MerchantID在新增相同交易對象時參數ExchangeMode都只能設為0:存證
API介接網址
- 測試環境:https://einvoice-stage.ecpay.com.tw/B2BInvoice/MaintainMerchantCustomerData
- 正式環境:https://einvoice.ecpay.com.tw/B2BInvoice/MaintainMerchantCustomerData
特店Request參數說明 (Json格式)
PlatformID String(10)
特約合作平台商代號
- 提供特約合作平台商向綠界申請開通後使用,一般廠商介接請放空值。
- 平台商使用時,MerchantID(特店編號)欄位僅限帶入已綁定子廠商的特店編號,以免造成失敗。
MerchantID String(10)
特店編號 必填
RqHeader Object
傳輸資料 必填
Timestamp String(10)
傳入時間 必填
綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間
注意事項:
- 驗證時間區間暫訂為10分鐘內有效,若超過此驗證時間則此次訂單將無法建立
參考資料:http://www.epochconverter.com/。 - 合作特店須進行主機「時間校正」,避免主機產生時差,延伸API無法正常運作。
Data String
加密資料 必填
回傳相關資料,此為加密過JSON格式的資料。加密方法說明
特店Request參數範例 (Json格式)
{
"MerchantID": "2000132",
"RqHeader": {
"Timestamp": 1234567890
},
"Data": "enter your data"
}
Data參數說明(Json格式)
MerchantID String(10)
特店編號 必填
Action String(10)
動作 必填
- Add: 新增
- Update: 編輯
- Delete: 刪除
CustomerNumber String(20)
公司編號
Identifier String(8)
統一編號 必填
type String(1)
交易對象 必填
- 1: 買方
- 2: 賣方
- 3: 買賣方
CompanyName String(60)
公司名稱 必填
PersonInCharge String(30)
公司負責人
Address String(100)
公司地址
TelephoneNumber String(30)
電話號碼
FacsimileNumber String(30)
傳真號碼
TradingSlang String(20)
交易暗語 必填
ExchangeMode String(1)
開立模式 必填
- 0: 存證,綠界會將您的發票資料上傳至財政部,僅適用於銷項發票。
※加值中心無法接收其他營業人開立給您的電子發票 - 1: 交換,綠界會將發票資料上傳至財政部發票傳輸軟體供對方營業人確認及接收。
※請務必先至財政部平台設定由綠界接收
EmailAddress String(80)
公司信箱 必填
- 可輸入多組,以半形分號區隔
- 格式檢核正規表達式為:^((([A-Za-z]|\d|[!#\$%&’\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([A-Za-z]|\d|[!#\$%&’\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([A-Za-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([A-Za-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([A-Za-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([A-Za-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([A-Za-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([A-Za-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([A-Za-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([A-Za-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.?$
SalesName String(30)
業務負責人
ContactAddress String(100)
聯絡地址
Data參數範例(Json格式)
{
"MerchantID": "2000132",
"Action": "Add",
"Identifier": "53538851",
"CustomerIdentifier": "53538851",
"type": "2",
"CompanyName": "小王電子支付",
"Address": "台北市內湖區大王路3號",
"TelephoneNumber": "22222222",
"TradingSlang": "123",
"ExchangeMode": "1",
"EmailAddress": "abc@pay.com.tw;def@pay.com.tw;ghi@pay.com.tw"
}
綠界Response參數說明 (Json格式)
PlatformID String(10)
特約合作平台商代號
MerchantID String(10)
特店編號
RpHeader Object
回傳資料
Timestamp String(10)
回傳時間
時間戳 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": "新增成功"
}