alalm3i/edfapay-laravel

Laravel's integration with EdfaPay payment gateway

v1.3 2024-05-07 14:06 UTC

This package is auto-updated.

Last update: 2024-05-07 14:09:01 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

This is an easy way to integrate with EdfaPay and get payment link correctly.

You can find EdfaPay API documentation here

Installation

You can install the package via composer:

composer require alalm3i/edfapay-laravel

You can publish the config file with:

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

This is the contents of the published config file:

return [
    'merchant_key' => env('EDFA_PAY_MERCHANT_KEY', null),
    'merchant_password' => env('EDFA_PAY_PASSWORD', null),
    'return_url' => env('EDFA_PAY_RETURN_URL', null),
];

Usage

 $response = \alalm3i\EdfaPay\Facades\EdfaPay::paymentURL([
        'order_id' => 'a001',
        'order_amount' => '10',
        'order_description' => 'description',
        'payer_first_name' => 'customer',
        'payer_last_name' => 'name',
        'payer_email' => 'nab@eee.com',
        'payer_mobile' => '966565555555',
        'payer_ip_address' => '176.44.76.222',
    ])->generate();
    
//$response = https://pay.edfapay.com/merchant/checkout/.....

This package cover generating the payment link only.

ToDo

  1. Generate payment URL
  2. Handle payment notifications
  3. Handle route for notification webhook

You can extend alalm3i\EdfaPay\EdfaPayNotification class to utilize it as a wrapper with some useful getters for notification callback payload. Just initialize it with the response object received from EdfaPay.

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

License

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