treerful/laravel-newebpay

A library of connecting newebpay's API service.

1.0.6 2022-05-05 06:51 UTC

Requires

• php: >=8.0
• guzzlehttp/guzzle: ^7.0.1

MIT

• w4ll4se

README

Laravel-NewebPay 為針對 laravel 所寫的金流套件，主要實作藍新金流（原智付通）功能。

主要實作項目：

• NewebPay MPG - 多功能收款
• NewebPay Cancel - 信用卡取消授權
• NewebPay Close - 信用卡請退款

Installation

1. Install from comoposer:

   composer require treerful/laravel-newebpay
   

2. Copy the config file (2 methods):

(a)In config/app.php

 'providers' => [
        /*
         * Laravel Framework Service Providers...
         */
        Illuminate\Auth\AuthServiceProvider::class,
        Illuminate\Broadcasting\BroadcastServiceProvider::class,
        ...
        ...
        Treerful\NewebPay\NewebPayServiceProvider::class,

After adding the ServiceProvider, Publish the config file.

php artisan vendor:publish

(b)Copy it manually without adding the provider.

cp vendor/treerful/laravel-newebpay/config/newebpay.php config/newebpay.php

Remember that the filename newebpay.php should not be changed!

1. Add aliases in config/app.php

    'aliases' => [
     ...
    'Storage' => Illuminate\Support\Facades\Storage::class,
    'URL' => Illuminate\Support\Facades\URL::class,
    'Validator' => Illuminate\Support\Facades\Validator::class,
    'View' => Illuminate\Support\Facades\View::class,
   
    'NewebPay' => Treerful\NewebPay\NewebPay::class,
    ]
   

Usage

設定 .env 檔

// .env

CASH_STORE_ID= ...
CASH_STORE_HASH_KEY= ...
CASH_STORE_HASH_IV= ...
CASH_STORE_DEBUG=true/false

CASH_RETURN_URL= ...
CASH_NOTIFY_URL= ...
CASH_CLIENT_BACK_URL= ...

設定 config/newebpay.php

可依據個人商業使用上做調整。

引用、初始化類別：

use Treerful\Pay2goInvoice\Invoice;

$newebpay = new NewebPay();

NewebPay MPG - 多功能支付

function order() 
{
    $newebpay = new NewebPay();
    return $newebpay->payment(
        no, // 訂單編號
        amt, // 交易金額
        desc, // 交易描述
        email // 付款人信箱
    )->submit();
}

基本上一般交易可直接在 config/newebpay.php做設定，裡面有詳細的解說，但若遇到特殊情況，可依據個別交易做個別 function 設定。

$newebpay = new NewebPay();
return $newebpay->payment(
    no, // 訂單編號
    amt, // 交易金額
    desc, // 交易描述
    email // 付款人信箱
)
->setTespondType() // 回傳格式
->setLangType() // 語言設定
->setTradeLimit() // 交易秒數限制
->setExpireDate() // 交易截止日
->setReturnURL() // 由藍新回傳後前景畫面要接收資料顯示的網址
->setNotifyURL() // 由藍新回傳後背景處理資料的接收網址
->setCutomerURL() // 商店取號網址
->setClientBackURL() // 付款取消後返回的網址
->setEmailModify() // 是否開放 email 修改
->setLoginType() // 是否需要登入智付寶會員
->setOrderComment() //商店備註
->setPaymentMethod() //付款方式 *依照 config 格式傳送*
->setCVSCOM() // 物流方式
->setTokenTerm() // 快速付款 token
->submit();

此版本1.5由籃新金流回傳後為加密訊息，所以回傳後需要進行解碼！

function returnURL(Request $request)
{
    $retrunData = $request->all();

    $newebpay = new NewebPay();
    $retrunData['data'] = $newebpay->decodeCallback($retrunData['TradeInfo']);

    return $retrunData;
}

NewebPay Cancel - 信用卡取消授權

function creditCancel()
{
    $newebpay = new NewebPay();
    return $newebpay->creditCancel(
        no, // 該筆交易的訂單編號
        amt,  // 該筆交易的金額
        'order' // 可選擇是由 order->訂單編號 或是 trade->藍新交易編號來做申請
        )->submit();
}

NewebPay Close - 信用卡請款

function requestPayment()
{
    $newebpay = new NewebPay();
    return $newebpay->requestPayment(
        no, // 該筆交易的訂單編號
        amt,  // 該筆交易的金額
        'order' // 可選擇是由 order->訂單編號 或是 trade->藍新交易編號來做申請
        )->submit();
}

NewebPay close - 信用卡退款

function requestRefund()
{
    $newebpay = new NewebPay();
    return $newebpay->requestRefund(
        no, // 該筆交易的訂單編號
        amt,  // 該筆交易的金額
        'order' // 可選擇是由 order->訂單編號 或是 trade->藍新交易編號來做申請
        )->submit();
}

Authors

• Wallase Huang - work - Github
• Treerful - Github

Official Reference

NewebPay Payment API

License

MIT