sandervanhooft / laravel-payable-redirect-mollie

Associate Mollie payments with Eloquent models

Associate Mollie payments with Eloquent models

Implementing Mollie payments in your Laravel 5.4 app does not have to be difficult. This package helps you by creating payment records and keeping the status in sync with Mollie. It is built on top of the very solid official Mollie PHP client. It supports one-off payments only; recurring payments are not (yet) supported.

Structure

config/
database/
docs/
routes/
src/
tests/

Install

Via Composer

$ composer require sander-van-hooft/laravel-payable-redirect-mollie

Next, you must install the service provider:

// config/app.php
'providers' => [
    ...
    SanderVanHooft\PayableRedirect\PayableRedirectServiceProvider::class,
];

And add the Mollie API key to the .env file in your project root. This is also where you can override the webhook route which Mollie calls when a payment status is updated:

# /.env:
...
MOLLIE_KEY=YOUR_MOLLIE_API_KEY_HERE
# MOLLIE_WEBHOOK_URL=your_url_relative/to_your_app_url

You can publish the migration with:

$ php artisan vendor:publish --provider="SanderVanHooft\PayableRedirect\PayableRedirectServiceProvider" --tag="migrations"

After the migration has been published you can create the payments-table by running the migrations:

$ php artisan migrate

Laravel automatically loads the routes from this package.

If you prefer this over configuring using the .env file (not required!) you can also publish the payable.php config file with:

$ php artisan vendor:publish --provider="SanderVanHooft\PayableRedirect\PayableRedirectServiceProvider" --tag="config"

In the config file, you can set the MOLLIE api key and override the default mollie payment webhook route. This is what the default config file looks like:

return [
    'mollie' => [
        'key' => env('MOLLIE_KEY', 'test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'),
        'webhook_url' => env('MOLLIE_WEBHOOK_URL', '/webhooks/payments/mollie'),
    ],
];

Usage

Basic usage

In your code, create a Payment record using the MolliePaymentGateway:

// Using some App\Order model (provided by you)

$order = new App\Order(['amount' => 12345]);
$order->save();

$paymentGateway = new SanderVanHooft\PayableRedirect\MolliePaymentGateway;

$payment = $paymentGateway->chargeAmountForPayable(
    $order->amount, // AMOUNT IN CENTS!!
    $order,
    'Some description',
    [ 'return_url' => 'http://some-return-url.com' ]
);

The payment amount is in eurocents!

The payment status will be kept in sync with Mollie: Mollie will call the webhook whenever the payment status changes. This will trigger your app to fetch the latest payment status from Mollie. Mollie has designed this process in this way for security reasons.

IsPayableTrait

For convenience you can use the isPayableTrait on your payable Eloquent model (the App\Order model in the example above). This enables you to call $order->payments.

use Illuminate\Database\Eloquent\Model;
use SanderVanHooft\PayableRedirect\Payment;
use SanderVanHooft\PayableRedirect\IsPayable\IsPayableTrait;

class Order extends Model
{
    use IsPayableTrait;
}

Events

PaymentEvents are dispatched for easy integration with your own custom listeners (see Laravel events and listeners). The following events are available:

• PaymentUpdated: this event is dispatched when Mollie calls the webhook. It checks whether the payment status really has changed. Depending on the new status, it dispatches one of the Mollie based events below.
• PaymentCancelled
• PaymentChargedBack
• PaymentExpired
• PaymentFailed
• PaymentOpened
• PaymentPaid
• PaymentPaidOut
• PaymentPending
• PaymentRefunded

Change log

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

Testing

Please mind that for testing the payment status synchronisation your app needs to be reachable on a public url by Mollie. Therefore, under normal circumstances, you cannot fully test this functionality on a local Laravel installation.

Make sure to configure the Mollie API key (MOLLIE_KEY) as an environment variable. This can for example be done in the phpunit.xml file.

$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Sander van Hooft
• All Contributors

License

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