Skip to content

A simple Laravel API implementation for all payment providers.

License

Notifications You must be signed in to change notification settings

isemptyru/laravel-payment-gateways

 
 

Repository files navigation

Laravel Payment Gateways (for APIs)

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

A simple Laravel implementation for all payment providers. This package supports Paystack, Flutterwave, Klasha, and Stripe.

Use Case

Have you had to implement limited SDKs for accepting payments on your mobile app. That's the problem this package solved.

With this package you can generate a payment link and return it to your mobile app when they make API calls and when the payment can be completed on the inapp browser.

When the customer completes their payment, this package verifies the payment and executes the code defined in your custom closure.

The closure should look like this:

use Stephenjude\PaymentGateway\DataObjects\PaymentData;

function (PaymentData $payment){
    $order->update([
        'status' => $payment->status, 
        'amount' => $payment->amount, 
        'currency' => $payment->currency
    ]);
    
    $customer->notify(new OrderPaymentNotification($order));
}

If you are using this package on the web this closure is the place where you can return a redirect after updating the customers order or sent notification.

Installation

You can install the package via composer:

composer require stephenjude/laravel-payment-gateways

You can publish the config file with:

php artisan vendor:publish --tag="payment-gateways-config"

Optionally, you can publish the views using

php artisan vendor:publish --tag="payment-gateways-views"

Usage

This package currently supports paystack, flutterwave, klasha and stripe.

How to initialize a payment session

use Stephenjude\PaymentGateway\PaymentGateway;
use Stephenjude\PaymentGateway\DataObjects\PaymentData;

$provider = PaymentGateway::make('paystack')

$paymentSession = $provider->initializePayment([
                'currency' => 'NGN', // required
                'amount' => 100, // required
                'email' => '[email protected]', // required
                'meta' => [ 'name' => 'Stephen Jude', 'phone' => '081xxxxxxxxx'],
                'closure' => function (PaymentData $payment){
                    /* 
                     * Payment verification happens immediately after the customer makes payment. 
                     * The payment data gotten from the verification will be injected into this closure.
                     */
                    logger('payment details', [
                       'currency' => $payment->currency, 
                       'amount' => $payment->amount, 
                       'status' => $payment->status,
                       'reference' => $payment->reference,   
                       'provider' => $payment->provider,   
                       'date' => $payment->date,                   
                    ]);
                },
            ]);

$paymentSession->provider;
$paymentSession->checkoutUrl;
$paymentSession->expires;

Paystack Setup

PAYSTACK_PUBLIC=
PAYSTACK_SECRET=

Flutterwave Setup

FLUTTERWAVE_PUBLIC=
FLUTTERWAVE_SECRET=

Klasha Setup

KLASHA_PUBLIC=
KLASHA_SECRET=

Stripe Setup

STRIPE_PUBLIC=
STRIPE_SECRET=

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.

About

A simple Laravel API implementation for all payment providers.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 78.1%
  • Blade 21.9%