Git Product home page Git Product logo

laravel-payment-gateways's Introduction

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 API call and the payment can be completed on the inapp browser.

When the customer completes their payment, this package verifies the payment and execute the code defined inside 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;

Pay4Me Setup

PAY4ME_PUBLIC=
PAY4ME_SECRET=

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.

laravel-payment-gateways's People

Contributors

dependabot[bot] avatar eyounelson avatar github-actions[bot] avatar stephenjude avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.