README

The free Laravel package to help you integrate payment with cryptomus.com

Use Cases

Create a payment link with cryptomus.com
Parse result from cryptomus.com
Example webhook

Features

Dynamic cryptomus.com credentials from config/cryptomus.php
Easy to create payment link with a simple line code

Requirements

PHP: 8.1 or higher
Laravel 9.0 or higher

Quick Start

If you prefer to install this package into your own Laravel application, please follow the installation steps below

Installation

Step 1. Install a Laravel project if you don't have one already

https://laravel.com/docs/installation

Step 2. Require the current package using composer:

composer require funnydevjsc/cryptomus-laravel-integrate

Step 3. Publish the controller file and config file

php artisan vendor:publish --provider="FunnyDev\Cryptomus\CryptomusServiceProvider" --tag="cryptomus"

If publishing files fails, please create corresponding files at the path config/cryptomus.php and app\Http\Controllers\CryptomusControllers.php from this package. And you can also further customize the CryptomusControllers.php file to suit your project.

Step 4. Update the various config settings in the published config file:

After publishing the package assets a configuration file will be located at config/cryptomus.php. Please contact cryptomus.com to get those values to fill into the config file.

Step 5. Add middleware protection:

app/Http/Kernel.php

<?php

namespace App\Http;

use Illuminate\Foundation\Http\Kernel as HttpKernel;

class Kernel extends HttpKernel
{
    // Other kernel properties...
    
    /**
     * The application's route middleware groups.
     *
     * @var array
     */
    protected $routeMiddleware = [
        // Other middlewares...
         'cryptomus' => 'App\Http\Middleware\CryptomusMiddleware',
    ];
}

Step 6. Add route:

routes/api.php

<?php

use Illuminate\Support\Facades\Route;
use App\Http\Controllers\CryptomusController;

// Other routes properties...

Route::group(['middleware' => ['cryptomus']], function () {
    Route::post('/cryptomus/webhook', [CryptomusController::class, 'webhook']);
});

}

Then your IPN (Webhook) URL will be something like https://yourdomain.ltd/api/cryptomus/webhook, and you should provide it to Cryptomus's account setting. You could provide it to routes/web.php if you want but remember that Cryptomus will check for referer matched with the pre-registration URL. So make sure that you provide them the right URL of website.

Testing

<?php

namespace App\Console\Commands;

use FunnyDev\Cryptomus\CryptomusSdk;
use Illuminate\Console\Command;

class CryptomusTestCommand extends Command
{
    protected $signature = 'cryptomus:test';

    protected $description = 'Test Cryptomus SDK';

    public function __construct()
    {
        parent::__construct();
    }

    public function handle()
    {
        $instance = new CryptomusSdk();
        echo $instance->create_payment(
            'INV-test-01',
            100,
            'USDT',
            'BSC',
            'INV-test-01',
            'https://yourdomain.ltd/invoices/INV-test-01',
            'https://yourdomain.ltd/invoices/INV-test-01',
            'https://yourdomain.ltd/invoices/INV-test-01?success=true' // Remember that param success=true or any similar is just for toast notification, do not put any logical process here
        );
    }
}

Feedback

Respect us in the Laravel Việt Nam

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email contact@funnydev.vn or use the issue tracker.

Credits

License

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

funnydevjsc / cryptomus-laravel-integrate

Maintainers

Details