stephenjude/laravel-payment-gateways

A simple Laravel API implementation for all payment providers like Paystack, Flutterwave, & Paypal etc.

3.0.5 2024-07-08 10:02 UTC

Requires

• php: ^8.1|^8.2|8.3
• archtechx/enums: *
• illuminate/contracts: ^9.0|^10.0|^11.0
• illuminate/http: ^9.0|^10.0|^11.0
• illuminate/support: ^9.0|^10.0|^11.0
• spatie/laravel-data: ^1.4|^2.0|^3.12
• spatie/laravel-package-tools: ^1.9.2

Requires (Dev)

• nunomaduro/collision: ^5.0|^6.0|^7.0||^8.0
• orchestra/testbench: ^6.0|^7.0|^8.0|^9.0
• pestphp/pest: ^1.21
• pestphp/pest-plugin-laravel: ^1.1
• phpstan/phpstan-phpunit: ^1.0
• phpunit/phpunit: ^9.5

MIT

• stephenjude

• laravel
• stephenjude
• laravel-payment-gateways

README

A simple Laravel implementation for all payment providers. This package supports Paystack, Monnify, Pay4Me Pay, Seerbit 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 in-app browser.

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

The closure should look like this:

use Stephenjude\PaymentGateway\DataObjects\TransactionData;

function (TransactionData $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 customer order or sending a 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, monnify, pay4me, seerbit, flutterwave, klasha and stripe.

How to initialize a payment session

use Stephenjude\PaymentGateway\PaymentGateway;
use Stephenjude\PaymentGateway\DataObjects\TransactionData;

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

$paymentSession = $provider->initializeCheckout([
    'currency' => 'NGN', // required
    'amount' => 100, // required
    'email' => '[e-mail]', // required
    'meta' => [ 'name' => 'Stephen Jude', 'phone' => '081xxxxxxxxx'],
    'closure' => function (TransactionData $payment){
        /* 
         * Payment verification happens immediately after the customer makes payment. 
         * The payment data obtained 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;

Accessing payment transaction data

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

$transactions = $provider->listTransactions(); // Returns array

$transaction = $provider->findTransaction(REFERENCE); // Returns Stephenjude\PaymentGateway\DataObjects\TransactionData 
$transaction->provider;
$transaction->email;
$transaction->amount;
$transaction->currency;
$transaction->reference;
$transaction->status;
$transaction->date;

Pawapay Setup

Required Env Variables

PAWAPAY_SECRET=

Checkout

use \Stephenjude\PaymentGateway\Enums\Provider;
use \Stephenjude\PaymentGateway\PaymentGateway;

$pawapay = PaymentGateway::make(Provider::PAWAPAY())->initializeCheckout([
    "amount" => 15,
    "country" => "ZMB",
    'meta' => [
        "description" => "Note of 4 to 22 chars",
        "reason" => "Ticket to festival"
    ]
]);

Pay4Me Setup

PAY4ME_PUBLIC=
PAY4ME_SECRET=

Monnify Setup

MONNIFY_PUBLIC=
MONNIFY_SECRET=
MONNIFY_CONTRACT_CODE=

Pay4Me Setup

SEERBIT_PUBLIC=
SEERBIT_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

• stephenjude
• All Contributors

License

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