模擬串接服務 - 直接交易查詢

經銷商『直接交易查詢』請求欄位
Id Name Description Type Additional Information
1 agent_uid 經銷商商務代號
string 必填
2 service 服務名稱
string 必填
{ "service_name": "api", "cmd": "api\/querydirect" }
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\/querydirect" }
JSON格式,AES256加密資料
3 encry_data 『直接交易查詢』欄位資料 string 必填
『直接交易查詢』欄位參考
JSON格式,AES256加密資料
直接交易查詢』欄位
Id Name Description Type Additional Information
1 store_uid 特約商店編號 string 必填
2 order_id 訂單編號 string 必填
3 cost 訂單總金額 string 必填
4 user_id 消費者帳號 string
直接交易查詢』回傳欄位
Id Name Description Type Additional Information
1 code 執行結果(B200,B500,100) string
2 msg 執行結果訊息 string
3 rows 查詢資料清單 array 交易成功可能含多筆退款或取消以及發票等相關資訊
每筆『交易查詢』欄位參考
交易查詢』欄位
Id Name Description Type Additional Information
1 uid Payment Hub之交易流水號 string
2 key 交易驗証碼 string
3 prc 主要交易回傳碼(retcode) string
4 finishtime 交易完成時間(YYYYMMDDHHmmss) string
5 cardno 銀行端口回傳碼 string
6 acode 授權碼 string
7 card_type 信用卡卡別 string 『信用卡別類型』值參考
8 issuing_bank 發卡行 string
9 issuing_bank_uid 發卡銀行代碼 string
10 is_agent_charge 是否為經銷商代收費模式 int 『是否為經銷商代收費模式』值參考
11 transaction_mode 交易服務類型 integer 『交易服務類型』值參考
12 supplier_name 交易之金融服務商 string
13 supplier_code 交易之金融服務商代碼 string 『金流供應商代碼』值參考
14 order_id 貴特店系統的訂單編號 string
15 user_id 消費者帳號 string
16 cost 總交易金額 string
17 currency 原交易幣別 string
18 actual_cost 實際交易金額 string
19 actual_currency 實際交易幣別 string
20 voucher_paid 有償票券項目 array 每筆『有償票券項目』欄位參考
21 voucher_free 無償票券項目 array 每筆『無償票券項目』欄位參考
22 price 請求交易點數/金額 string
23 actual_price 實際交易點數/金額 string
24 recharge_code 交易產品代碼 string
25 love_cost 愛心捐款金額 string
26 retmsg 回傳訊息 string
27 pay_mode_uid 付費方法編號 string
28 actual_pay_mode 自行收款(付費方法編號為37或付費方法為CASH)時的實際付款方式 string 『自行收款付款方式』值參考
29 pfn 付費方法 string
30 trans_type 付款種類 string 『交易類型定義』值參考
31 redeem 信用卡紅利資訊 JSON 格式 string 『紅利資訊』值參考
32 installment 信用卡分期資訊 JSON 格式 string 『分期資訊』值參考
33 payment_name 定期定額式/定期分期式扣款名稱 string
34 nois 定期定額式/定期分期式扣繳期數 string
35 group_id 1.定期定額式扣款編號
2.定期分期式扣款編號
string
36 bank_id 虛擬帳號銀行代碼 string
37 expired_date 有效日期(YYYYMMDDHHmmss)
虛擬帳號、超商代碼、無卡分期資訊
string
38 appropriation_date 預計撥款日期(YYYYMMDD) string
39 result_type 虛擬帳號、超商代碼 資料格式類型 integer 『閘道內容回傳格式類型』值參考
40 result_content_type 資料內容所屬支付名稱 string 『資料內容所屬支付名稱』值參考
41 result_content 虛擬帳號、超商代碼 資料內容 string 『虛擬帳號回傳欄位』值參考
『ibon』值參考
『FamiPort』值參考
『Life-ET』值參考
『超商條碼繳費』值參考
『悠遊付線下交易回傳欄位』值參考
『全支付線下交易回傳欄位』值參考
『Pi錢包線下交易回傳欄位』值參考
『LINE Pay線下交易回傳欄位』值參考
『街口支付線下交易回傳欄位』值參考
42 refund_order 退款訂單資訊(多筆格式) array 每筆『交易查詢-退款資訊』欄位參考
43 cancel_order 取消訂單資訊(多筆格式) array 每筆『交易查詢-取消資訊』欄位參考
44 invoice_state 發票開立狀態 integer 『電子發票開立狀態類型』值參考
45 invoice_date 發票開立日期(YYYYMMDD) string
46 invoice_wordtrack 發票字軌 string
47 invoice_number 發票號碼 string
48 invoice_rand_code 電子發票隨機碼 string
49 invoice_seller_ban 賣方統一編號 string
50 invoice_seller_name 賣方名稱 string
51 invoice_buyer_ban 買方統一編號 string
52 invoice_buyer_name 買方名稱 string
53 invoice_left_qrcode 電子發票左邊QrCode內容 string
54 invoice_middle_barcode 電子發票中間Barcode內容(格式Code-39) string
55 invoice_right_qrcode 電子發票右邊QrCode內容 string
56 invoice_title_type 電子發票列印標題格式 integer 『電子發票紙本列印標題類型』值參考
57 invoice_title 電子發票列印標題格式 string
58 invoice_print_type 電子發票列印類型 integer 『電子發票列印類型』值參考
59 invoice_print_device 電子發票列印設備 integer 『電子發票列印設備』值參考
60 invoice_amount 電子發票銷售總額 string
61 invoice_sales_amount 電子發票銷售額 string
62 invoice_tax_amount 電子發票稅額 string
63 invoice_order_detail 電子發票全部產品明細(JSON格式) string 『商品細項』值參考
64 invoice_ratetype 電子發票稅率別 integer 『電子發票稅率別』值參考
65 invoice_tax_rate 電子發票稅率:預設0.05(零稅與免稅帶0) float
66 invoice_remark 發票註記(依加值中心提供註記功能) string
67 invoice_input_type 電子發票開立類型 integer 『電子發票開立類型』值參考
68 invoice_cloud_type 電子發票開立類型-雲端發票類型 string 『雲端發票類型』值參考
69 invoice_mobile_code 當invoice_cloud_type為2時紀錄的手機條碼 string
70 invoice_tax_id 當invoice_cloud_type為2時紀錄的統一編號 string
71 invoice_tax_title 當invoice_cloud_type為2時紀錄的買受人公司名稱 string
72 invoice_natural_person 當invoice_cloud_type為3時紀錄的自然人憑證條碼 string
73 invoice_m_post_zone 當invoice_cloud_type為4時紀錄中獎時紙本發票郵遞區號 string
74 invoice_m_address 當invoice_cloud_type為4時紀錄中獎時紙本發票收件住址 string
75 invoice_love_code 當invoice_input_type為2時紀錄的愛心碼 string
76 invoice_b2b_title 當invoice_input_type為3時紀錄的發票抬頭 string
77 invoice_b2b_id 當invoice_input_type為3時紀錄的統一編號 string
78 invoice_b2b_post_zone 當invoice_input_type為3時紀錄的郵遞區號 string
79 invoice_b2b_address 當invoice_input_type為3時紀錄的發票地址 string
80 invoice_allowance 電子發票折讓資訊 array 每筆『電子發票折讓資訊』欄位參考
81 items 訂單商品項目 array 每筆『商品項目』欄位參考
82 echo_0 自訂回傳參數 1 string
83 echo_1 自訂回傳參數 2 string
84 echo_2 自訂回傳參數 3 string
85 echo_3 自訂回傳參數 4 string
86 echo_4 自訂回傳參數 5 string
信用卡別類型』 值內容
Value Description Type Additional Information
0 無法辨識或支付方式為非信用卡類 string
1 VISA string
2 MasterCard string
3 JCB string
4 AMEX string
是否為經銷商代收費模式』 值內容
Value Description Type Additional Information
1 是經銷商代收費模式 integer
0 不是經銷商代收費模式 integer
交易服務類型』 值內容
Value Description Type Additional Information
0 尚未進行閘道交易 integer
1 代收代付 integer
2 特店模式 integer
金流供應商代碼』 值內容
Value Description Type Additional Information
A1 裕富數位資融 string
A2 三環亞洲 string
B0 新光銀行 string
B1 永豐銀行 string
B2 合作金庫 string
B3 台北富邦 string
B4 玉山銀行 string
B5 台新銀行 string
B6 聯合信用卡處理中心 string
B7 台中商銀 string
B8 中國信託商業銀行 string
B9 上海商業儲蓄銀行 string
BA 第一銀行 string
BB 元大商業銀行 string
BC 凱基銀行 string
BD 國泰世華商業銀行 string
BE 華泰商業銀行 string
BF 兆豐銀行 string
BG 環滙亞太 string
BH 彰化銀行 string
BI 土地銀行 string
S0 全網行銷股份有限公司(FamiPort) string
S1 安源資訊股份有限公司(ibon) string
S2 萊爾富國際股份有限公司(Hi-Life) string
T0 高鉅科技 string
T1 藍新金流 string
T2 統一客樂得(黑貓Pay)
W0 統振 string
W1 遊戲橘子數位 string
W2 台灣連線(LINEPay) string
W3 博經 string
W4 街口電子支付 string
W5 悠遊卡 string
W6 一卡通票證 string
W7 iCash string
W8 全支付(PXPay plus) string
W9 拍付國際資訊(Pi錢包) string
WA 全盈支付(全盈+Pay) string
E0 MYTIX string
有償票券項目』欄位
Id Name Description Type Additional Information
1 product_id 票券群組編號(最長限32 Bytes) string
2 serial_number 票券券號(特約商店下的每一個票券群組的票券券號必須是唯一) string
3 name 票券名稱 string
4 cost 票券金額 integer
5 issuer 發行者 string 『有價票券發行者』值參考
6 refund_return_type 退款時,票券金額是否歸還 string 『退款時票券金額是否歸還』值參考
無償票券項目』欄位
Id Name Description Type Additional Information
1 product_id 票券群組編號(最長限32 Bytes) string
2 serial_number 票券券號(特約商店下的每一個票券群組的票券券號必須是唯一) string
3 name 票券名稱 string
4 cost 票券金額 integer
5 issuer 發行者 string 『免費票券發行者』值參考
自行收款付款方式』 值內容
Value Description Type Additional Information
REMITTENCE 轉帳匯款 string
CASH 現金交易 string
ZINGALAPAY 銀角零卡 string
LINEPAY LINE Pay string
JKO 街口支付 string
PI Pi 拍錢包 string
EASYWALLET 悠遊付 string
PXPAY 全支付 string
PLUSPAY 全盈支付 string
ALIPAY 支付寶 string
WECHAT 微信支付 string
MOMO Momo收款 string
SHOPEE 蝦皮拍賣收款 string
ETMALL 東森收款 string
PCSTORE PChome商店街收款 string
PCHOME24H PChome24H收款 string
RUTEN 露天拍賣收款 string
SHOPLINE Shop line收款 string
FOODPANDA 熊貓收款 string
UBEREATS Uber eats收款 string
CYBERBIZ Cyberbiz收款 string
YAHOOBID YAHOO拍賣收款 string
RAKUTEN 樂天市場收款 string
CAROUSELL 旋轉拍賣收款 string
FACEBOOKGROUPS FB社團收款 string
PINKOI Pinkoi收款 string
91APP 91APP收款 string
COD_MYPAY MYPAY物流代收 string
COD_HCT 新竹物流代收 string
COD_TCAT 黑貓宅急便代收 string
COD_MYSHIP711 7-ELEVEN賣貨便代收 string
COD_FAMISTORE 好賣+代收 string
COD_HISHIPBUYER 萊賣貨代收 string
COD_KERRYTJ 嘉里大榮代收 string
CSTORECODE_IBON 超商代碼(IBON) string
CSTORECODE_FAMIPORT 超商代碼(FamiPort) string
CSTORECODE_LIFEET 超商代碼(Life-ET) string
CSTORECODE_OKGO 超商代碼(OK GO) string
ETICKET_EASYCARD 悠遊卡 string
ETICKET_IPASS 一卡通 string
ETICKET_ICASH iCash string
CRYPTO_BTC 比特幣 string
CRYPTO_ETH 乙太幣 string
TELECOM_CHT 中華電信代收 string
TELECOM_FET 遠傳電信代收 string
TELECOM_TWM 台灣大哥大代收 string
TELECOM_TSTAR 台灣之星代收 string
TELECOM_APT 亞太電信代收 string
ECPAY_CREDIT 綠界收款(信用卡) string
ECPAY_WEBATM 綠界收款(網路ATM) string
ECPAY_ATM 綠界收款(自動櫃員機) string
ECPAY_CVS 綠界收款(超商代碼) string
ECPAY_BARCODE 綠界收款(超商條碼) string
ECPAY_TWQR 綠界收款(行動支付) string
NEWEBPAY_CREDIT 藍新收款(信用卡付款) string
NEWEBPAY_VACC 藍新收款(銀行 ATM 轉帳付款) string
NEWEBPAY_WEBATM 藍新收款(網路銀行轉帳付款) string
NEWEBPAY_BARCODE 藍新收款(超商條碼繳費) string
NEWEBPAY_CVS 藍新收款(超商代碼繳費) string
NEWEBPAY_LINEPAY 藍新收款(LINE Pay 付款) string
NEWEBPAY_ESUNWALLET 藍新收款(玉山 Wallet) string
NEWEBPAY_TAIWANPAY 藍新收款(台灣 Pay) string
NEWEBPAY_CVSCOM 藍新收款(超商取貨付款) string
CREDITCARD_TCB 信用卡(合庫銀行) string
CREDITCARD_ESUNBANK 信用卡(玉山銀行) string
CREDITCARD_FIRSTBANK 信用卡(第一銀行) string
CREDITCARD_FUBONBANK 信用卡(台北富邦銀行) string
CREDITCARD_TSIB 信用卡(台新銀行) string
CREDITCARD_NCCC 信用卡(聯信) string
CREDITCARD_CTBC 信用卡(中信銀行) string
CREDITCARD_KGIBANK 信用卡(凱基銀行) string
CREDITCARD_YUANTABANK 信用卡(元大銀行) string
CREDITCARD_CUB 信用卡(國泰世華銀行) string
CREDITCARD_BANKSINOPAC 信用卡(永豐銀行) string
CREDITCARD_MEGABANK 信用卡(兆豐銀行) string
CREDITCARD_GLOBALPAYMENTS 信用卡(環匯亞太) string
AMEX_TSIB 美國運通(台新銀行) string
AMEX_CTBC 美國運通(中信銀行) string
AMEX_NCCC 美國運通(聯信) string
UNIONPAY_TCB 銀聯卡(合庫銀行) string
UNIONPAY_ESUNBANK 銀聯卡(玉山銀行) string
UNIONPAY_NCCC 銀聯卡(聯信) string
UNIONPAY_TSIB 銀聯卡(台新銀行) string
UNIONPAY_KGIBANK 銀聯卡(凱基銀行) string
UNIONPAY_YUANTABANK 銀聯卡(元大銀行) string
UNIONPAY_BANKSINOPAC 銀聯卡(永豐銀行) string
UNIONPAY_CUB 銀聯卡(國泰世華銀行) string
BARCODE_SKBANK 超商繳費條碼(新光銀行) string
BARCODE_ESUNBANK 超商繳費條碼(玉山銀行) string
BARCODE_CTBC 超商繳費條碼(中信銀行) string
TWPAY_BOT 台灣Pay(台灣銀行) string
TWPAY_LANDBANK 台灣Pay(台灣土地銀行) string
TWPAY_TCB 台灣Pay(合庫銀行) string
TWPAY_FIRSTBANK 台灣Pay(第一銀行) string
TWPAY_HNCB 台灣Pay(華南銀行) string
TWPAY_CHB 台灣Pay(彰化銀行) string
TWPAY_SCSB 台灣Pay(上海商銀) string
TWPAY_CUB 台灣Pay(國泰世華銀行) string
TWPAY_MEGABANK 台灣Pay(兆豐銀行) string
TWPAY_BOK 台灣Pay(高雄銀行) string
TWPAY_TBB 台灣Pay(台灣企銀) string
TWPAY_KTB 台灣Pay(京城銀行) string
TWPAY_HWATAIBANK 台灣Pay(華泰銀行) string
TWPAY_SUNNYBANK 台灣Pay(陽信銀行) string
TWPAY_KSCC 台灣Pay(基隆二信) string
TWPAY_TFCCBANK 台灣Pay(淡水一信) string
TWPAY_HCFCBANK 台灣Pay(新竹一信) string
TWPAY_TSCA 台灣Pay(台中二信) string
TWPAY_CH6C 台灣Pay(彰化六信) string
TWPAY_HL2C 台灣Pay(花蓮二信) string
TWPAY_ESUNBANK 台灣Pay(玉山銀行) string
TWPAY_TSIB 台灣Pay(台新銀行) string
TWPAY_AFISC 台灣Pay(農金資) string
TWPAY_YUANTABANK 台灣Pay(元大銀行) string
TWPAY_CTBC 台灣Pay(中信銀行) string
TWPAY_FAST 台灣Pay(南農中心) string
TWPAY_SCU 台灣Pay(南資中心) string
交易類型定義』 值內容
Value Description Type Additional Information
1 一般 (預設) integer
2 分期 integer
3 紅利 integer
紅利資訊』欄位
Id Name Description Type Additional Information
1 type 紅利類型 string 『紅利資訊類型』值參考
2 used 紅利折抵點數 string
3 amount 自付金額 string
分期資訊』欄位
Id Name Description Type Additional Information
1 period_number 分期期數 integer
2 total 應付總金額 integer
3 first 第一期應付金額 integer
4 every 第二期起每期應付金額 integer
閘道內容回傳格式類型』 值內容
Value Description Type Additional Information
0 無法辨識 integer
1 網址 integer
2 超連結本文 integer
3 xml integer
4 json integer
5 csv integer
6 串流 integer
資料內容所屬支付名稱』 值內容
Value Description Type Additional Information
E_COLLECTION 虛擬帳號 string
IBON iBON string
FAMIPORT FamiPort string
LIFEET LIFE-ET string
WEBATM WEBATM string
CREDITCARD 信用卡 string
UNIONPAY 銀聯卡 string
SVC 點數卡(GASH ,Imoney) string
ABROAD 海外信用卡 string
ALIPAY 支付寶 string
WECHAT 微信支付 string
LINEPAYON LINE Pay線上付款 string
LINEPAYOFF LINE Pay線下付款 string
WECHATOFF 微信支付線下 string
APPLEPAY APPLE PAY string
GOOGLEPAY Google Pay string
EACH eACH交易 string
CARDLESS 無卡分期 string
PION Pi 拍錢包線上 string
PIOFF Pi 拍錢包線下 string
AMEX 美國運通 string
JKOON 街口支付線上 string
JKOOFF 街口支付線下 string
ALIPAYOFF 支付寶線下 string
EASYWALLETON 悠遊付線上 string
EASYWALLETOFF 悠遊付線下 string
TWPAYOFF 台灣Pay線下 string
PXPAYOFF 全支付線下 string
AFP 後付款 string
BARCODE 超商條碼繳費 string
虛擬帳號回傳欄位』欄位
Id Name Description Type Additional Information
1 PinCode 虛擬帳號 string
2 LimitDate 繳費有效期限,格式YYYYMMDDHHmmss string
3 BankCode 銀行代碼 string
ibon』欄位
Id Name Description Type Additional Information
1 PinCode 超商代碼(可用qrcode被掃) string
2 LimitDate 超商代碼繳費有效期限,格式YYYYMMDDHHmmss string
3 BarCode1 三段條碼繳費條碼1(格式:Code-39 barcode) string
4 BarCode2 三段條碼繳費條碼2(格式:Code-39 barcode) string
5 BarCode3 三段條碼繳費條碼3(格式:Code-39 barcode) string
6 BarcodeEndDate 三段條碼繳費期限,格式YYYYMMDDHHmmss string
FamiPort』欄位
Id Name Description Type Additional Information
1 PinCode 繳費代碼(可憑此代碼至設備列印繳費單) string
2 LimitDate 繳費有效期限,格式YYYYMMDDHHmmss string
3 BarCode1 三段條碼繳費條碼1(格式:Code-39 barcode) string
4 BarCode2 三段條碼繳費條碼2(格式:Code-39 barcode) string
5 BarCode3 三段條碼繳費條碼3(格式:Code-39 barcode) string
6 BarcodeEndDate 三段條碼繳費期限,格式YYYYMMDDHHmmss string
Life-ET』欄位
Id Name Description Type Additional Information
1 PinCode 代碼(不可用來繳費) string
2 LimitDate 繳費有效期限,格式YYYYMMDDHHmmss string
3 BarCode1 三段條碼繳費條碼1(格式:Code-39 barcode) string
4 BarCode2 三段條碼繳費條碼2(格式:Code-39 barcode) string
5 BarCode3 三段條碼繳費條碼3(格式:Code-39 barcode) string
超商條碼繳費』欄位
Id Name Description Type Additional Information
1 BarCode1 繳費條碼1(格式:Code-39 barcode) string
2 BarCode2 繳費條碼2(格式:Code-39 barcode) string
3 BarCode3 繳費條碼3(格式:Code-39 barcode) string
4 LimitDate 繳費有效期限,格式YYYYMMDDHHmmss string
悠遊付線下交易回傳欄位』欄位
Id Name Description Type Additional Information
1 Remark 交易註記說明文字 string
2 TradeNo 金流服務商訂單編號 string
3 OrderTotalCost 交易金額 string
4 InvoiceVehicle 發票載具
(消費者綁定悠遊付時設定之發票載具)
string
5 CitizenDigitalCertificate 自然人憑證條碼 string
6 LoveCode 愛心碼 string
7 EventCode 活動代碼 string
8 PaymentType 付款方式 string
9 DebitAmount 付款方式扣款金額(折抵後金額) string
全支付線下交易回傳欄位』欄位
Id Name Description Type Additional Information
1 PosID POS 機號或設備機號 string
2 PosTradeTime POS 端交易日期時間,格式:YYYYMMDDHHmmss string
3 Remark 交易註記說明文字 string
4 TradeNo 金流服務商訂單編號 string
5 OrderTotalCost 交易金額 string
6 TradeDate 金流服務商交易時間,格式YYYYMMDDHHmmss string
7 DebitAmount 付款方式扣款金額(折抵後金額) string
8 InvoiceVehicle 發票載具
(消費者綁定全支付時設定之發票載具)
string
9 MerMemToken 第三方合作廠商會員識別資訊 string
10 Pan 遮碼卡號 string
11 IsControversy 是否為爭議款 0.不是 1.是 string
Pi錢包線下交易回傳欄位』欄位
Id Name Description Type Additional Information
1 TradeNo 金流服務商訂單編號 string
2 OrderTotalCost 交易金額 string
3 TradeDate 金流服務商交易時間,格式YYYYMMDDHHmmss string
4 InvoiceVehicle 發票載具
(消費者綁定Pi錢包時設定之發票載具)
string
LINE Pay線下交易回傳欄位』欄位
Id Name Description Type Additional Information
1 TradeNo 金流服務商訂單編號 string
2 OrderTotalCost 交易金額 string
3 TradeDate 金流服務商交易時間,格式YYYYMMDDHHmmss string
4 InvoiceVehicle 發票載具
(消費者綁定LINE Pay時設定之發票載具)
string
5 RedeemAmount 折扣金額 string
6 RedeemType 折扣種類 string 『紅利資訊類型』值參考
7 OrderRealCost 實際付款額 string
8 PaymentType 付款方式
BALANCE 一卡通
CREDIT_CARD 信用卡
string
9 CreditAmt 持卡人自付金額 string
10 IsControversy 是否為爭議款 0.不是 1.是 string
街口支付線下交易回傳欄位』欄位
Id Name Description Type Additional Information
1 PosID POS 機號或設備機號 string
2 PosTradeTime POS 端交易日期時間,格式:YYYYMMDDHHmmss string
3 Remark 交易註記說明文字 string
4 TradeNo 金流服務商訂單編號 string
5 OrderTotalCost 交易金額 string
6 TradeDate 金流服務商交易時間,格式YYYYMMDDHHmmss string
7 DebitAmount 付款方式扣款金額(折抵後金額) string
8 InvoiceVehicle 發票載具
(消費者綁定街口支付時設定之發票載具)
string
9 MerMemToken 第三方合作廠商會員識別資訊 string
10 Pan 遮碼卡號 string
11 IsControversy 是否為爭議款 0.不是 1.是 string
交易查詢-退款資訊』欄位
Id Name Description Type Additional Information
1 uid Payment Hub之交易流水號 string
2 prc 主要交易回傳碼(retcode) string
3 cost 總交易金額 string
4 currency 原交易幣別 string
5 actual_cost 實際交易金額 string
6 actual_currency 實際交易幣別 string
7 voucher_paid 有償票券項目 array 每筆『有償票券項目』欄位參考
8 retmsg 回傳訊息 string
9 finishtime 交易完成時間(YYYYMMDDHHmmss) string
10 appropriation_date 預計撥款日期(YYYYMMDD) string
11 invoice_state 發票開立狀態 integer 『電子發票開立狀態類型』值參考
12 invoice_date 發票開立日期(YYYYMMDD) string
13 invoice_wordtrack 發票字軌 string
14 invoice_number 發票號碼 string
15 invoice_rand_code 電子發票隨機碼 string
16 invoice_seller_ban 賣方統一編號 string
17 invoice_seller_name 賣方名稱 string
18 invoice_buyer_ban 買方統一編號 string
19 invoice_buyer_name 買方名稱 string
20 invoice_left_qrcode 電子發票左邊QrCode內容 string
21 invoice_middle_barcode 電子發票中間Barcode內容(格式Code-39) string
22 invoice_right_qrcode 電子發票右邊QrCode內容 string
23 invoice_title_type 電子發票列印標題格式 integer 『電子發票紙本列印標題類型』值參考
24 invoice_title 電子發票列印標題內容 string
25 invoice_print_type 電子發票列印類型 integer 『電子發票列印類型』值參考
26 invoice_print_device 電子發票列印設備 integer 『電子發票列印設備』值參考
27 invoice_amount 電子發票銷售總額 string
28 invoice_sales_amount 電子發票銷售額 string
29 invoice_tax_amount 電子發票稅額 string
30 invoice_order_detail 電子發票全部產品明細(JSON格式) string 『商品細項』值參考
31 invoice_ratetype 電子發票稅率別 integer 『電子發票稅率別』值參考
32 invoice_tax_rate 電子發票稅率:預設0.05(零稅與免稅帶0) float
33 invoice_remark 發票註記(依加值中心提供註記功能) string
34 invoice_input_type 電子發票開立類型 integer 『電子發票開立類型』值參考
35 invoice_cloud_type 電子發票開立類型-雲端發票類型 string 『雲端發票類型』值參考
36 invoice_mobile_code 當invoice_cloud_type為2時紀錄的手機條碼 string
37 invoice_tax_id 當invoice_cloud_type為2時紀錄的統一編號 string
38 invoice_tax_title 當invoice_cloud_type為2時紀錄的買受人公司名稱 string
39 invoice_natural_person 當invoice_cloud_type為3時紀錄的自然人憑證條碼 string
40 invoice_m_post_zone 當invoice_cloud_type為4時紀錄中獎時紙本發票郵遞區號 string
41 invoice_m_address 當invoice_cloud_type為4時紀錄中獎時紙本發票收件住址 string
42 invoice_love_code 當invoice_input_type為2時紀錄的愛心碼 string
43 invoice_b2b_title 當invoice_input_type為3時紀錄的發票抬頭 string
44 invoice_b2b_id 當invoice_input_type為3時紀錄的統一編號 string
45 invoice_b2b_post_zone 當invoice_input_type為3時紀錄的郵遞區號 string
46 invoice_b2b_address 當invoice_input_type為3時紀錄的發票地址 string
47 invoice_allowance 電子發票折讓資訊 array 每筆『電子發票折讓資訊』欄位參考
交易查詢-取消資訊』欄位
Id Name Description Type Additional Information
1 uid Payment Hub之交易流水號 string
2 prc 主要交易回傳碼(retcode) string
3 cost 總交易金額 string
4 currency 原交易幣別 string
5 actual_cost 實際交易金額 string
6 actual_currency 實際交易幣別 string
7 retmsg 回傳訊息 string
8 finishtime 交易完成時間(YYYYMMDDHHmmss) string
電子發票開立狀態類型』 值內容
Value Description Type Additional Information
0 不處理或已無效(預設) integer
1 等候處理中 integer
2 發票開立成功 integer
3 發票開立失敗(系統或特約商店發票相關設定不正確) integer
4 作癈 integer
5 發票開立失敗(系統發生錯誤) integer
6 折讓 integer
電子發票紙本列印標題類型』 值內容
Value Description Type Additional Information
1 文字 integer
2 圖形(圖片網址) integer
電子發票列印類型』 值內容
Value Description Type Additional Information
0 不列印 自行處置 integer
1 列印 電子發票 + 商品明細 integer
2 只印電子發票 integer
3 只印商品明細 integer
電子發票列印設備』 值內容
Value Description Type Additional Information
0 自行處理 integer
1 SUNMI V2 PRO integer
商品細項』欄位
Id Name Description Type Additional Information
1 Description 商品名稱 string 必填
2 Quantity 數量 string 必填
3 UnitPrice 單價 string 必填
4 Amount 總金額 string 必填
電子發票稅率別』 值內容
Value Description Type Additional Information
1 應稅(預設) integer
2 零稅率 integer
3 免稅 integer
電子發票開立類型』 值內容
Value Description Type Additional Information
0 未使用電子發票開立 integer
1 雲端發票 integer
2 發票捐贈 integer
3 實體發票 integer
雲端發票類型』 值內容
Value Description Type Additional Information
0 未使用雲端發票類型 integer
2 手機條碼 integer
3 自然人憑證條碼 integer
4 以E-Mail寄送 integer
電子發票折讓資訊』欄位
Id Name Description Type Additional Information
1 uid 發生之退款交易流水號(UID) string
2 allowance_no 折讓單號 string
3 amount 電子發票折讓金額 integer
4 order_detail 電子發票折讓明細(JSON格式) string 『商品細項』值參考
商品項目』欄位
Id Name Description Type Additional Information
1 id 商品編號 string
2 name 商品名稱 string
3 cost 商品單價 string
4 amount 商品數量 string
5 total 商品小計 string
有價票券發行者』 值內容
Value Description Type Additional Information
1 平台折價券(預設) string
2 行銷合作夥伴折價券 string
退款時票券金額是否歸還』 值內容
Value Description Type Additional Information
1 票券金額給予特店(預設) string
2 票券金額能歸還消費者 string
3 票券金額歸還經銷商 string
免費票券發行者』 值內容
Value Description Type Additional Information
1 平台折價券 string
2 行銷合作夥伴折價券 string
3 商店折價券 string
紅利資訊類型』 值內容
Value Description Type Additional Information
1 全額 integer
2 部分 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

範例程式碼