README

Installation

You can install the package via composer:

composer require sepayvn/laravel-sepay

Phiên bản dành cho Laravel 7, 8 và PHP 7.4 trở lên

composer require "sepayvn/laravel-sepay:dev-lite"

You can publish and run the migrations with:

php artisan vendor:publish --tag="sepay-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="sepay-config"

This is the contents of the published config file:

return [
    'webhook_token' => env('SEPAY_WEBHOOK_TOKEN'),
    'pattern' => env('SEPAY_MATCH_PATTERN', 'SE'),
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="sepay-views"

Usage

Tạo SePayWebhookListener

php artisan make:listener SePayWebhookListener

<?php

namespace App\Listeners;

use App\Models\User;
use SePay\SePay\Events\SePayWebhookEvent;
use SePay\SePay\Notifications\SePayTopUpSuccessNotification;

class SePayWebhookListener
{
    /**
     * Create the event listener.
     */
    public function __construct()
    {
        //
    }

    /**
     * Handle the event.
     */
    public function handle(SePayWebhookEvent $event): void
    {
        // Xử lý tiền vào tài khoản
        if ($event->sePayWebhookData->transferType === 'in') {
            // Trường hợp $info là user id
            $user = User::query()->where('id', $event->info)->first();
            if ($user instanceof User) {
                $user->notify(new SePayTopUpSuccessNotification($event->sePayWebhookData));
            }
        } else {
            // Xử lý tiền ra tài khoản
        }
    }
}

Đối với Laravel 11 trở xuống (7, 8, 9, 10)

Đăng ký SePayWebhookListener vào app/Providers/EventServiceProvider.php

    protected $listen = [
        ...
        \SePay\SePay\Events\SePayWebhookEvent::class => [
            \App\Listeners\SePayWebhookListener::class,
        ],
    ];

Đối với Laravel 11, SePayWebhookListener đặt ở trong thư mục app/Listeners thì Laravel sẽ tự động gắn với SePayWebhookEvent bạn không cần phải đăng ký với Provider, tránh bị gọi 2 lần.

Nếu bạn kiểm tra thấy SePayWebhookListener chưa lắng nghe SePayWebhookEvent thì bạn có thể làm như sau: vào phương thức boot trong app/Providers/AppServiceProvider.php
```
public function boot(): void
{
    \Illuminate\Support\Facades\Event::listen(
        \SePay\SePay\Events\SePayWebhookEvent::class,
        \App\Listeners\SePayWebhookListener::class,
    );
}
```

Webhook

Truy cập SePay Webhooks
Bấm nút Thêm Webhook ở góc trên bên phải
Các cần điền thì bạn hãy điền, riêng các mục sau cần lưu ý
1. thay domain.com thành tên miền của bạn
2. Kiểu chứng thực: là Api Key
3. API Key: nhập vào 1 dãy bí mật ngẫu nhiên gồm chữ và số (không có dấu như hình ví dụ nhé)
Sửa file .env trong ứng dụng Laravel của bạn thành như sau
1. SEPAY_WEBHOOK_TOKEN - Là API Key nhập ở bước 3.3 ở trên
2. SEPAY_MATCH_PATTERN - Mặc định là SE bạn có thể sửa cho phù hợp với ứng dụng của bạn

Kiểm tra với Postman

Bấm import trên postman và dán đoạn mã dưới đây vào

curl --location 'https://domain.com/api/sepay/webhook' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer Apikey đây_là_khóa_bí_mật' \
--data '{
    "gateway": "MBBank",
    "transactionDate": "2024-05-25 21:11:02",
    "accountNumber": "0359123456",
    "subAccount": null,
    "code": null,
    "content": "Thanh toan QR SE123456",
    "transferType": "out",
    "description": "Thanh toan QR SE123456",
    "transferAmount": 1700000,
    "referenceCode": "FT123456789",
    "accumulated": 0,
    "id": 123456
}'

Testing

composer test

Ủng hộ nhà phát triển

Bạn có thể hỗ trợ nhà phát triển gói này bằng cách sử dụng những dịch vụ sau:

Thuê tôi 👉 Facebook | Telegram
FlashPanel: Effortless Server Management
FlashShop: Nền tảng mua bán sản phẩm số #1 tại Việt Nam

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

sepayvn / laravel-sepay

Maintainers

Details