README.md

This is my package laravel-moyasar

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Installation

You can install the package via composer:

composer require roduankd/laravel-moyasar

Then you need to define these variables in .env

MOYASAR_API_PUBLISHABLE_KEY="your api key goes here"
MOYASAR_CURRENCY=USD

Optionally, you can publish the config file with:

php artisan vendor:publish --tag="laravel-moyasar-config"

This is the contents of the published config file:

return [
    // Required
    // Specify where to render the form
    // Can be a valid CSS selector and a reference to a DOM element
    'element' => '.mysr-form',

    // Required
    // Currency of the payment transaction
    'currency' => env('MOYASAR_CURRENCY', 'USD'),

    // Required
    // A small description of the current payment process
    'description' => 'default description',

    // Required
    'publishable_key' => env('MOYASAR_API_PUBLISHABLE_KEY', null),

    // Required
    // This URL is used to redirect the user when payment process has completed
    // Payment can be either a success or a failure, which you need to verify on you system (We will show this in a couple of lines)
    'callback_url' => 'moyasar.callback',

    // Highly recommended
    // This URL is use by moyasar to send to save the payment ID before redirecting the user to 3-D Secure
    // this is the default on complete route name
    'on_complete_url' => 'moyasar.complete',

    // Optional
    // Required payments methods
    // Default: ['creditcard', 'applepay', 'stcpay']
    'methods' => ['creditcard', 'applepay', 'stcpay'],
];

Then, you'll need to define the "moyasar.callback" route. this is the route that users will be directed to it after completing the payment process.

Route::get('memberships/{membership}/payment/thanks', [MembershipController::class, 'thanks'])->name('moyasar.callback');

Optionally, you can override the default payment completed route. this route is visited by moyasar server before the user is redirected to "moyasar.callback" route.

Route::post('memberships/{membership}/payment/completed', [RoduanKD\LaravelMoyasar\Controllers\PaymentController::class, 'store'])->name('moyasar.complete');

Note: you can define the routes however you want.

Using Listeners

When you override the "moyasar.complete" route you'll probably need to change something in your model whenever the payment process is done. You can define listeners to TransactionCreated event which contains payment_id and all "moyasar.complete" route parameters.

php artisan make:listener MarkMembershipAsPaid --event=\RoduanKD\LaravelMoyasar\Events\TransactionCreated

in your listener you can update the model however you need.

/**
 * Handle the event.
 *
 * @param  \RoduanKD\LaravelMoyasar\Events\TransactionCreated  $event
 * @return void
 */
public function handle(TransactionCreated $event)
{
    $membership = Membership::find($event->parameters['membership']);
    $membership->paid_at = now();
    $membership->update();
}

and you'll need to update the route for init component

<x-moyasar-init amount="100" :on-complete="route('moyasar.complete', $membership)" />

Optionally, you can publish the views using

php artisan vendor:publish --tag="laravel-moyasar-views"

Usage

add moysar style to you page to the page head.

@include('moyasar::head')

then include init component and provide all the options you need

<x-moyasar-init amount="100" />

Testing

composer test

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

• Roduan Kareem Aldeen
• All Contributors

License

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