Download the PHP package yoshocon/yoshocon-spgateway without Composer
On this page you can find all versions of the php package yoshocon/yoshocon-spgateway. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package yoshocon-spgateway
Laravel Spgateway
Laravel Spgateway是一個開源的 智付通 非官方套件
該套件參考於 LeoChien
目錄
- 環境要求
- 安裝
- 配置
- 使用
- 多功能收款MPG
- 電子發票
- 退款/取消授權
- 平台費用扣款指示
- 版本紀錄
- License
要求
- PHP >= 7
- Laravel >= 5
- Composer
安裝
配置
Laravel 應用
-
在
config/app.php
註冊 ServiceProvider 和 Facade (Laravel 5.5 無須手動註冊) -
創建設定檔:
-
修改
config/spgateway.php
中對應的參數。 - 在
.env
中加入下列設定
使用
多功能收款MPG
快速上手
建立訂單
解析智付通回傳訂單資料
查詢訂單
可用方法
generate ($amount, $email, $itemDesc [, $params ])
產生智付通建立訂單必要欄位
參數
amount (Integer)
: 訂單金額email (String)
: 訂購人EmailitemDesc (String)
: 商品描述[ params (Array) ]
: 其他可選參數,詳見下方參數表
回傳
(Class)
: MPG Class實體,其中getPostData() 及 getPostDataEncrypted()會回傳即將送到智付通的表單資料
使用範例
參數表
欄位 | 型態 | 可選值 | 預設 | 備註 |
---|---|---|---|---|
MerchantOrderNo | Varchar(20) | 商店自訂編號,若無填寫則由套件產生 | ||
LangType | String | zh-tw / en |
zh-tw |
|
TradeLimit | Number | 60 ~ 900 | 180 | |
ExpireDate | String (Ymd) | 範例:20171231 | ||
ReturnURL | Url | |||
NotifyURL | Url | |||
CustomerURL | Url | |||
ClientBackURL | Url | |||
EmailModify | Number | 0 / 1 |
1 | |
LoginType | Number | 0 / 1 |
0 | |
OrderComment | String | |||
TokenTerm | String | 信用卡快速結帳 | ||
CREDIT | Number | 0 / 1 |
信用卡一次付清 | |
CreditRed | Number | 0 / 1 |
信用卡紅利 | |
InstFlag | Number | 0 / 1 |
信用卡分期付款 | |
UNIONPAY | Number | 0 / 1 |
銀聯卡 | |
WEBATM | Number | 0 / 1 |
WebATM | |
VACC | Number | 0 / 1 |
ATM轉帳 | |
CVS | Number | 0 / 1 |
超商代碼繳費 | |
BARCODE | Number | 0 / 1 |
條碼繳費,訂單金額需介於20~20000 |
備註
- 支付方式若無選擇,默認開啟智付通後台設定方式
- 若無傳送訂單編號預設會建立年月日時分秒+6位隨機字串的訂單編號,e.g. 20180110151950mTHuUY
send ()
前台送出智付通訂單建立表單
使用範例
parse ($tradeInfo)
解析智付通交易結果回傳參數,也適用於取號完成
參數
tradeInfo (String)
: 智付通回傳,經AES加密之交易資料
回傳
詳見智付通文件第六節:交易支付系統回傳參數說明 / 第七節:取號完成系統回傳參數說明
使用範例
search ($orderNo, $amount)
產生智付通查詢訂單必要欄位
參數
orderNo (String)
: 訂單編號amount (Integer)
: 訂單金額
回傳
詳見智付通文件第四章:交易查詢系統回應訊息
使用範例
電子發票
快速上手
開立發票
觸發開立發票
作廢發票
查詢發票
可用方法
generate ($params)
產生智付通開立電子發票必要欄位
參數
params (Array)
: 詳見下方可選參數
回傳
(Class)
: Class實體,其中getPostData() 及 getPostDataEncrypted()包含即將送到智付通的表單資料
使用範例
可選參數
欄位 | 必填 | 型態 | 可選值 | 預設 | 備註 |
---|---|---|---|---|---|
TransNum | String | 智付寶平台交易序號 | |||
MerchantOrderNo | String | 商店自訂編號,若無填寫則由套件產生 | |||
Status | Number | 0 / 1 / 3 |
1 | 開立發票方式 | |
CreateStatusTime | String (Y-m-d) | 範例:2017-12-31 | |||
Category | String | B2B / B2C |
B2C |
||
BuyerName | ✔ | String | |||
BuyerUBN | String | ||||
BuyerAddress | String | ||||
BuyerEmail | |||||
CarrierType | String | 0 / 1 |
1 | ||
CarrierNum | String | 0 / 1 |
0 | ||
LoveCode | Number | ||||
PrintFlag | String | Y / N |
Y |
||
TaxType | String | 1 / 2 / 3 / 9 |
1 |
||
TaxRate | Number | 5 |
|||
CustomsClearance | Number | 1 / 2 |
|||
Amt | Number | 若無填寫則由套件計算 | |||
AmtSales | Number | ||||
AmtZero | Number | ||||
AmtFree | Number | ||||
TaxAmt | Number | 若無填寫則由套件計算 | |||
TotalAmt | ✔ | Number | |||
ItemName | ✔ | Array | |||
ItemCount | ✔ | Array | |||
ItemUnit | ✔ | Array | |||
ItemPrice | ✔ | Array | |||
ItemTaxType | Array | ||||
ItemAmt | Array | 若無填寫則由套件計算 | |||
Comment | String |
備註
- 本套件僅提供快速串接方式,詳細稅額計算方式請務必與公司財會人員進行確認
send()
傳送開立發票請求到智付通
回傳
詳見智付通文件第四節之二:開立發票系統回應訊息
使用範例
generateTrigger ($invoiceTransNo, $orderNo, $amount)
產生智付通觸發開立電子發票必要資訊
參數
invoiceTransNo (String)
: 智付寶開立序號orderNo (String)
: 商店自訂編號amount (Integer)
: 發票金額
回傳
(Class)
: Class實體,其中getTriggerPostData() 及 getTriggerPostDataEncrypted()會回傳即將送到智付通的表單資料
使用範例
sendTrigger()
送出觸發開立電子發票請求到智付通
回傳
詳見智付通文件第四節之四:觸發開立發票系統回應訊息
使用範例
generateInvalid ($receiptNumber, $invalidReason)
產生智付通觸發開立電子發票必要資訊
參數
receiptNumber (String)
: 發票號碼receiptNumber (String)
: 作廢原因
回傳
(Class)
: Class實體,其中getInvalidPostData() 及 getInvalidPostDataEncrypted()會回傳即將送到智付通的表單資料
使用範例
sendInvalid()
送出觸發開立電子發票請求到智付通
回傳
詳見智付通文件第五節之二:作廢發票系統回應訊息
使用範例
search($orderNo, $amount)
查詢發票
參數
orderNo (String)
: 商店自訂編號amount (Integer)
: 發票金額
回傳
詳見智付通文件第七節之二:查詢發票系統回應訊息
使用範例
退款/取消授權
因智付通信用卡退費有尚未請款需串接取消授權API,已請款需串接退款API之規則,本功能旨在整合此一過程,降低開發人員負擔 另外也提供非即時交易退款功能
快速上手
可用方法
generate ($orderNo, $amount[, $notifyUrl = null, $delayed = false, $params = []])
產生智付通退費 / 取消授權必要欄位
參數
orderNo (String)
: 商店自訂編號amount (String)
: 訂單金額,若不想全額退款請於可選參數中傳送Amt欄位[ notifyUrl (String) ]
: 接受取消授權結果位址,於取消授權或非即時交易時才需填寫[ delayed (Boolean) ]
: 是否為非即時交易[ params (Array) ]
: 詳見下方參數表
回傳
(Class)
: Class實體,其中getPostData() 及 getPostDataEncrypted()包含即將送到智付通的表單資料;getPostType()為cacnel時,訂單準備取消授權,為refund時,訂單準備退款
使用範例
可選參數
- 即時交易
欄位 | 必填 | 型態 | 備註 |
---|---|---|---|
RefundAmt | Number | 請退款金額,若發動退費後不退全額則需傳送此參數 |
- 非即時交易
欄位 | 必填 | 型態 | 備註 |
---|---|---|---|
AccNo | ✔ | String | 退款金額轉入之帳號 |
BankNo | ✔ | String | 金融機構總行代號 |
SubBankCode | ✔ | String | 金融機構分行代號 |
AccName | ✔ | String | 帳戶使用名稱 |
RefundAmt | ✔ | Number | 退款金額,必須小於等於訂單金額 |
Id | + | String | 買方身分證字號,Id及UBN需擇一填寫 |
UBN | + | String | 買方統一編號,Id及UBN需擇一填寫 |
send()
傳送退費 / 取消授權請求到智付通
回傳
取消授權:詳見智付通文件第五節:取消授權完成後系統回應訊息
退款:詳見智付通文件第五節:系統回應訊息
使用範例
平台費用扣款指示
快速上手
可用方法
generate ($merchantID, $amount, $feeType, $balanceType)
產生智付通扣款指示必要欄位
參數
orderNo (String)
: 商店自訂編號amount (String)
: 金額feeType (Integer)
: 費用類別balanceType (Integer)
: 交易正負值
回傳
(Class)
: Class實體,其中getPostData() 及 getPostDataEncrypted()包含即將送到智付通的表單資料
使用範例
send()
傳送扣款指示請求到智付通
回傳
本文件未公開,請向合作之智付通業務人員索取
使用範例
版本紀錄
1.1.0
- 非信用卡退款
- MPG交易串接增加支付寶欄位(測試功能)
1.0.0
- MPG交易串接 / 查詢
- 電子發票
- 退款 / 取消授權
- 平台扣款指示
License
Laravel Spgateway is open-sourced software licensed under the MIT license