B2C電子發票API技術文件

資料驗證／捐贈碼驗證

應用場景

特店系統可使用此API來驗證捐贈碼是否存在

❗ 注意事項：
1. 使用捐贈碼時，可先呼叫捐贈碼驗證API進行檢核，降低輸入錯誤造成無法捐贈。
2. 本API資料來源為財政部捐贈碼資料庫，綠界會定期下載進行更新。

API介接網址

  • 測試環境：https://einvoice-stage.ecpay.com.tw/B2CInvoice/CheckLoveCode
  • 正式環境：https://einvoice.ecpay.com.tw/B2CInvoice/CheckLoveCode

HTTPS傳輸協定

  • Content Type ：application/json
  • HTTP Method ：POST

特店傳入參數(Json格式)

PlatformID String(10)
特約合作平台商代號

  • 這個參數是專為與綠界簽約的指定平台商所設計，只有在申請開通後才能使用。
  • 如果您是一般廠商，請在介接時將此參數欄位保留為空。
  • 對於平台商，在使用時需要在MerchantID(特店編號)欄位中填入與您已經完成綁定子廠商的MerchantID(特定編號)。
    請注意，只能使用已綁定的子廠商編號，以避免操作失敗。綁定作業請洽所屬業務。

MerchantID String(10)
特店編號 必填

  1. 測試環境合作特店編號
  2. 正式環境金鑰取得

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)
特店編號 必填

LoveCode String(7)
受贈單位之捐贈碼 必填

  • 捐贈碼以阿拉伯數字為限，最少三碼，最多七碼。
  • 內容定位採「文字格式」，首位可以為零

Data參數範例(Json格式)

				
					{
    "MerchantID": "2000132",
    "LoveCode": "1680000"
}

綠界回傳參數格式

  • 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代表有取得查詢結果，其餘代碼均為失敗。

RtnMsg String(200)
回應訊息

IsExist String(1)
捐贈碼是否存在 

  • 若回應代碼[RtnCode]為1(成功)時，請參照此欄位值判定捐贈碼是否存在
  • Y : 存在
    N: 不存在

OrganName String(100)
組織名稱 

若參數[IsExist]為Y(存在)時，此欄位才會有值

Data參數範例

				
					{
    "RtnCode": 1,
    "RtnMsg": "成功取得查詢結果",
    "IsExist": "Y",
    "OrganName": "綠界科技"
}

YAML

提供的 YAML 文件用於定義 API 的配置、結構、操作和基礎設施管理等資訊，方便開發人員理解和使用 API。

				
					openapi: 3.1.0
info:
  title: ECPay Mobile Barcode Verification API
  version: 1.0.0
servers:
  - url: https://einvoice.ecpay.com.tw
    description: Production Environment
  - url: https://einvoice-stage.ecpay.com.tw
    description: Testing Environment
paths:
  /B2CInvoice/CheckBarcode:
    post:
      summary: Mobile Barcode Verification
      description: Verify the existence of a mobile barcode.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - MerchantID
                - RqHeader
                - Data
              properties:
                PlatformID:
                  type: string
                  description: Platform identifier (optional)
                MerchantID:
                  type: string
                  description: Merchant identifier
                RqHeader:
                  type: object
                  properties:
                    Timestamp:
                      type: number
                      description: Timestamp of the request
                Data:
                  type: string
                  description: Encrypted data in JSON format
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  PlatformID:
                    type: string
                    description: Platform identifier
                  MerchantID:
                    type: string
                    description: Merchant identifier
                  RpHeader:
                    type: object
                    properties:
                      Timestamp:
                        type: number
                        description: Timestamp of the response
                  TransCode:
                    type: integer
                    description: Transmission code
                  TransMsg:
                    type: string
                    description: Transmission message
                  Data:
                    type: string
                    description: Encrypted data in JSON format
        '400':
          description: Invalid request
        '500':
          description: Server error
components:
  schemas:
    requestBody.Data:
      type: object
      properties:
        MerchantID:
          type: string
          description: Merchant identifier
        BarCode:
          type: string
          description: Mobile barcode (8 characters)
    responses.Data:
      type: object
      properties:
        RtnCode:
          type: integer
          description: Response code
        RtnMsg:
          type: string
          description: Response message
        IsExist:
          type: string
          description: Mobile barcode existence status (Y or N)
        OrganName:
          type: string
          description: Organization Name

Copyright © Green World FinTech Service Co., Ltd. All rights reserved.

綠界官方網站