Laravel ECPay

Laravel ECPay 為串接綠界的非官方套件

系統需求

• v3.x
  • PHP >= 8.0
  • Laravel >= 9.0
• v2.x
  • PHP >= 7.2 且 < 8.0
  • Laravel < 9 且 >= 6.0
• v1.x (不維護更新)
  • PHP >= 7 且 < 8.0
  • Laravel < 6.0 且 >= 5.7

安裝

composer require tsaiyihua/laravel-ecpay

環境設定

php artisan vendor:publish --tag=ecpay

這裡會將設定檔 ecpay.php 複製一份到 config 的目錄下。

.env 裡加入

ECPAY_MERCHANT_ID=
ECPAY_HASH_KEY=
ECPAY_HASH_IV=
ECPAY_INVOICE_HASH_KEY=
ECPAY_INVOICE_HASH_IV=

• 金流測試用的參數值請參考介接文件 ecpay_gw_p110.pdf 第11頁。
• 查詢發票用的參數請請參考介接文件 ecpay_004.pdf 第6頁。

用法

基本用法

• 產品資料單筆時可簡單只傳送 ItemName 及 TotalAmount

use TsaiYiHua\ECPay\Checkout;

class CheckoutController extends Controller
{
    protected $checkout;
    
    public function __construct(Checkout $checkout)
    {
        $this->checkout = $checkout;
    }

    public function sendOrder()
    {
        $formData = [
            'UserId' => 1, // 用戶ID , Optional
            'ItemDescription' => '產品簡介',
            'ItemName' => 'Product Name',
            'TotalAmount' => '2000',
            'PaymentMethod' => 'Credit', // ALL, Credit, ATM, WebATM
        ];
        return $this->checkout->setPostData($formData)->send();
    }

需要分期付款時

• 加上 withInstallment(分期期數)
• 信用卡分期可用參數為:3,6,12,18,24
• ex： 3,6 範例
  承上，在 return 時，加上 withInstallment 即可

    return $this->checkout->setPostData($formData)->withInstallment('3,6')->send();

定期定額扣款

• 加上 withPeriodAmount($periodAmt)

範例

承上，加上參數，帶入 withPeriodAmount 即可

...
    $periodAmt = [
        'PeriodAmount' => 2550,
        'PeriodType' => 'M',
        'Frequency' => '1',
        'ExecTimes' => 10,
        'PeriodReturnURL'
    ];
    return $this->checkout->setPostData($formData)->withPeriodAmount($periodAmt)->send();

需要開立發票時

• 加上 withInvoice($invData) 即可。
• 開立發票時，產品內容必須要符合即定格式傳送，不能只帶 ItemName 及 TotalAmount
• 開立發票時，特店必須要有會員系統並傳送會員相關資料
• 測試開立發票時，MerchantID 請設 2000132

範例

use TsaiYiHua\ECPay\Checkout;

class CheckoutController extends Controller
{
    protected $checkout;
    
    public function __construct(Checkout $checkout)
    {
        $this->checkout = $checkout;
    }

    public function sendOrder()
    {
        $items[0] = [
            'name' => '產品333',
            'qty' => '3',
            'unit' => '個',
            'price' => '150'
        ];
        $formData = [
            'itemDescription' => '產品簡介',
            'items' => $items,
            'paymentMethod' => 'Credit',
            'userId' => 1
        ];
        $invData = [
            'Items' => $items,
            'UserId' => 1,
            'CustomerName' => 'User Name',
            'CustomerAddr' => 'ABC 123',
            'CustomerEmail' => 'email@address'
        ];
        return $this->checkout->setPostData($formData)->withInvoice($invData)->send();
    }

查詢訂單

use TsaiYiHua\ECPay\QueryTradeInfo;

class QueryTradeController extends Controller
{
    protected $queryTradeInfo;
    
    public function __construct(QueryTradeInfo $queryTradeInfo)
    {
        $this->queryTradeInfo = $queryTradeInfo;
    }
    
    public function queryInfo($orderId)
    {
        return $this->queryTradeInfo->getData($orderId)->query();
    }
}

查詢發票

use TsaiYiHua\ECPay\QueryInvoice;

class QueryInvoiceController extends Controller
{
    protected $queryInvoice;

    public function __construct(QueryInvoice $queryInvoice)
    {
        $this->queryInvoice = $queryInvoice;
    }

    public function queryInvInfo($orderId)
    {
        return $this->queryInvoice->getData($orderId)->query();
    }
}

開立發票

use TsaiYiHua\ECPay\Invoice;
use TsaiYiHua\ECPay\Constants\ECPayDonation;
use TsaiYiHua\ECPay\Services\StringService;

class InvoiceController extends Controller
{
    public function __construct(Invoice $invoice)
    {
        $this->invoice = $invoice;
    }

    public function issueInvoice()
    {
        $itemData[] = [
            'name' => 'product name',
            'qty' => 1,
            'unit' => 'piece',
            'price' => 5000
        ];
        $invData = [
            'UserId' => 1,
            'Items' => $itemData,
            'CustomerName' => 'User Name',
            'CustomerEmail' => 'email@address.com',
            'CustomerPhone' => '0912345678',
            'OrderId' => StringService::identifyNumberGenerator('O'),
            'Donation' => ECPayDonation::Yes,
            'LoveCode' => 168001,
            'Print' => 0,
            'CarruerType' => 1
        ];
        return $this->invoice->setPostData($invData)->send();
    }
}

套件中有設定和綠界溝通用的route及基本處理方法，如果要有自己的處理邏輯要用自己寫好的route，擔心和套件原設定的route衝突時

• 在 app/Http/Providers/AppServiceProvider 的 register 加入

ECPay::ignoreRoutes();

如果要用自己傳送資料的頁面

• 方法一： 在 .env 裡使用 ECPAY_SEND_FORM 的環境變數來指定。
• 方法二： 直接指定 ECPay::$sendForm 的值來指定。

所有文件列的參數基本上都可用，參數用法請參考綠界串接文件

• 回傳參數的背景通知(ReturnURL)，套件裡有預設的網址，但只止於通知，如果要有寫入資料庫的設計，要再設計自己的回傳通知網址。
• OrderResultURL 為結帳完返回自已站台的網址，不能與 ReturnURL 相同。

參考文件

• 綠界科技全方位金流信用卡介接技術文件 (2021-08-19)
  • V 5.2.8
  • 文件編號 gw_p110
  • 文件位置 documents/ecpay_gw_p110.pdf
• 綠界科技B2C電子發票介接技術文件 (2022-01-03)
  • V 3.6.4
  • 文件編號 gw_i100
  • 文件位置 documents/ecpay_004.pdf
• 綠界科技全方位金流介接技術文件 (2021-11-30)
  • V 5.3.11
  • 文件編號 gw_p100
  • 文件位置 documents/ecpay_011.pdf