模擬串接服務 - 查詢請款單

經銷商『查詢請款單』請求欄位
Id Name Description Type Additional Information
1 agent_uid 經銷商商務代號
 string 必填
2 service 服務名稱
 string 必填
{
    "service_name": "api",
    "cmd": "api\/companyinvoiceinquiry"
}
JSON格式，AES256加密資料
3 encry_data 『查詢請款單』欄位資料 string 必填
『查詢請款單』欄位參考
JSON格式，AES256加密資料
特約商店『查詢請款單』請求欄位
Id Name Description Type Additional Information
1 store_uid 特約商店商務代號
 string 必填
2 service 服務名稱
 string 必填
{
    "service_name": "api",
    "cmd": "api\/companyinvoiceinquiry"
}
JSON格式，AES256加密資料
3 encry_data 『查詢請款單』欄位資料 string 必填
『查詢請款單』欄位參考
JSON格式，AES256加密資料
『查詢請款單』欄位
Id Name Description Type Additional Information
1 store_uid 請款方商務代號 string 必填
2 page_code 請款系統請款單號 string
3 store_order_id 客戶自訂請款單號 string 必填
『查詢請款單』回傳欄位
Id Name Description Type Additional Information
1 code 資料接收回傳代碼 string 『查詢結果對應代碼』值參考
2 msg 查詢結果訊息 string
3 resultData 執行結果 object 『執行結果』欄位參考
『查詢結果對應代碼』 值內容
Value Description Type Additional Information
A0000 查詢成功 string
A0001 查無資料 string
A0002 請款系統代碼或客戶自訂請款單號，兩者需有一個有值 string
『執行結果』欄位
Id Name Description Type Additional Information
1 code 查詢結果代碼 string 『查詢結果對應代碼』值參考
2 msg 查詢結果訊息 string
3 page_code 請款系統請款單號 string
4 store_uid 請款方商務代號 string
5 key 驗證碼 string
6 buy_store_uid 購買方商務代號(不一定有) string
7 state 狀態 int
8 store_order_id 客戶自訂請款單號 string
9 tong_bian 賣方統編 string
10 company_name 賣方公司名稱 string
11 company_tel 賣方公司電話 string
12 sales_name 賣方負責業務姓名 string
13 sales_tel 賣方負責業務電話 string
14 sales_phone 賣方負責業務手機 string
15 sales_mail 賣方負責業務mail string
16 buy_company_tong_bian 買方公司統編 string
17 buy_company_name 買方公司名稱 string
18 buy_company_tel 買方公司電話 string
19 buy_name 買方業務姓名 string
20 buy_phone 買方業務手機 string
21 buy_tel 買方業務電話 string
22 buy_mail 購買人mail string
23 date_start 請款起始日 string
24 date_end 請款截止日 string
25 create_type 發票先開後開 int 『收據類型開立先後順序』值參考
26 product_tax_type 商品價格是否含稅 int 『資料含不含稅』值參考
27 tax_type 營業稅 int 『發票稅率別』值參考
28 tax 稅額 string
29 pay_mode 付款方式 array 每筆『付款方式』欄位參考
30 final_pay_mode 消費者決定使用的支付工具 string 『付款方式』值參考
31 product_detail 商品 array 每筆『請款項目資料』欄位參考
32 discount_type 折扣方式 int 『折扣類型』值參考
33 discount 依據折扣方式代表不同的意義如果是打折不得大於100 int
34 total_discount_amount 折扣總額 int
35 sales_amount 銷售額合計 int
36 tax_amount 營業稅額 int
37 total_amount 請款總金額 int
38 memo 備註 string
39 invoice_date 發票日期，日期格式 YYYY-MM-DD string
40 invoice_number 發票號碼 string
41 echo_0 自訂參數 string
42 echo_1 自訂參數 string
43 echo_2 自訂參數 string
44 echo_3 自訂參數 string
45 echo_4 自訂參數 string
46 invoice_detail 請款發票明細 array 每筆『發票明細』欄位參考
47 cash_order 金流訂單 array 每筆『金流訂單資訊』欄位參考
48 refund_order 退款訂單 array 每筆『』欄位參考
『收據類型開立先後順序』 值內容
Value Description Type Additional Information
0 不開 integer
1 發票先開 integer
2 發票後開 integer
3 收據先開 integer
4 收據後開 integer
『資料含不含稅』 值內容
Value Description Type Additional Information
0 無效
1 含稅 integer
2 不含稅 integer
『發票稅率別』 值內容
Value Description Type Additional Information
0 無效值
1 應稅(預設) integer
2 零稅率 integer
3 免稅 integer
『付款方式』 值內容
Value Description Type Additional Information
all 全部可用支付方式(預設) string
MobilePayAll 指定下列線上行動支付方式
支付寶、Pi 拍錢包、LINEPay、微信、街口支付、悠遊付		 string
CREDITCARD 信用卡 string
CSTORECODE 超商代碼 string
WEBATM WEBATM string
E_COLLECTION 虛擬帳號 string
UNIONPAY 銀聯卡 string
SVC 點數卡(GASH ,Imoney) string
ABROAD 海外信用卡 string
ALIPAY 支付寶 string
WECHAT 微信支付 string
DIRECTDEBIT 定期定額扣款 string
DIRECTDEBIT_ABROAD 定期定額扣款(國外信用卡) string
LINEPAYON LINE Pay線上付款 string
LINEPAYOFF LINE Pay線下付款 string
WECHATOFF 微信支付線下 string
APPLEPAY APPLE PAY string
GOOGLEPAY Google Pay string
EACH eACH交易 string
C_INSTALLMENT 信用卡分期 string
C_REDEEM 信用卡紅利 string
CARDLESS 無卡分期 string
PION Pi 拍錢包線上 string
PIOFF Pi 拍錢包線下 string
AMEX 美國運通 string
JKOON 街口支付線上 string
JKOOFF 街口支付線下 string
ALIPAYOFF 支付寶線下 string
M_RECHARGE 儲值交易 string
EASYWALLETON 悠遊付線上 string
EASYWALLETOFF 悠遊付線下 string
AFP 後付款 string
BARCODE 超商條碼繳費 string
CASH 自行收款 string
『請款項目資料』欄位
Id Name Description Type Additional Information
1 name 請款名目 string
2 price 定價 string
3 selling_price 售價 string
4 quantity 數量 string
『折扣類型』 值內容
Value Description Type Additional Information
0 無折扣 integer
1 減價 integer
2 打折 integer
『發票明細』欄位
Id Name Description Type Additional Information
1 description 商品名稱 string
2 quantity 數量 int
3 unit_price 單價 int
4 amount 總額 int
『金流訂單資訊』欄位
Id Name Description Type Additional Information
1 cash_uid 金流系統訂單單號 string
2 pay_date 付款完成時間，格式YYYY-mm-dd H:i:s string
『』欄位
Id Name Description Type Additional Information
1 uid 退款uid string
2 store_order_id 退款訂單編號 string
3 key 退款訂單驗證碼 string
4 cash_uid 金流退款訂單編號 string
5 product_detail 退款產絣資訊 array 每筆『請款項目資料』欄位參考
6 date 退款日期 string
7 prc 退款狀態 string
8 msg 退款訊息 string
9 cost 退款請求金額 string
10 actual_cost 實際退款金額 string
11 finishtime 退款完成時間 string
12 echo_0 自訂回傳參數 1 string 非必填
13 echo_1 自訂回傳參數 2 string
14 echo_2 自訂回傳參數 3 string
15 echo_3 自訂回傳參數 4 string
16 echo_4 自訂回傳參數 5 string
17 allowance_number 折讓單單號 string
18 tax 稅額 string
19 invoice_create_state 發票開立狀態 int 『發票處理狀態』值參考
20 invoice_date 發票日期 string
21 invoice_number 發票號碼 string
22 invoice_rand_code 發票隨機碼 string
23 invoice_seller_ban 發票賣方統編 string
24 invoice_buyer_ban 發票買方統編 string
25 invoice_left_qrcode 發票左邊qrcode string
26 invoice_middle_barcode 發票中間barcode string
27 invoice_right_qrcode 發票右邊qrcode string
28 invoice_sales_amount 電子發票銷售額 string
29 invoice_tax_amount 電子發票稅額 string
30 invoice_rate_type 發票稅率 string 『發票稅率別』值參考
『發票處理狀態』 值內容
Value Description Type Additional Information
0 無發票 integer
2 開立 integer
3 作廢 integer
4 折讓 integer
AES256資料加密方式說明

1、所有的API送出HTTPs請求之欄位中，service 和 encry_data 欄位皆進行 AES256+BASE64 加密處理。
2、AES加密，格式為CBC，長度為256bits，金鑰長度32，IV長度16，傳遞內文為加密後組合IV並經過Base64轉換後傳出。

方式：
使用自訂的AES256函式將JSON資料加密後，再將IV資料和此AES256加密後的JSON資料串聯後，使用base64再進行加密成ASCII字串即可完成加密。

    PHP加密示意：
    AesEncrypt -> base64_ecode($IV . $JSON)

    C#加密示意：
    AesEncrypt -> (bytes)IV+(bytes)Json -> toBase64

    Java加密示意：
    AesEncrypt -> (bytes)IV+(bytes)Json -> toBase64

    Node.js加密示意：
    AesEncrypt -> concat([IV,JSON], [IV_SIZE,JSON_SIZE]) -> toString('base64')
    Python加密示意：
    AesEncrypt -> (bytes)IV+(bytes)Json -> base64.b64encode

範例程式碼