stephenjude / paystack-lite
Paystack Lite - Use Paystack Checkout Form on the go.
Requires
- illuminate/support: ^8.0|^9.0
- xeviant/laravel-paystack: ^1.5
Requires (Dev)
- orchestra/testbench: ^6.0|^7.0
- phpunit/phpunit: ^9.0|^9.5
This package is auto-updated.
Last update: 2023-09-07 17:31:28 UTC
README
# Paystack Lite - Use Paystack Checkout Form on the go. Paystack Lite creates a blade directive you can include in your views. This is the easiest integration of paystack checkout form for Laravel applications.Installation
- Install PaystackLite with composer
composer require stephenjude/paystack-lite
-
if you are using Laravel less than 5.4 Add
Stephenjude\PaystackLite\PaystackLiteServiceProvider::class
to theproviders
array in yourconfig/app.php
. -
Open your .env file and add your public key, secret key, customer default email and payment url like so:
PAYSTACK_PUBLIC_KEY=xxxxxxxxxxxxx
PAYSTACK_SECRET_KEY=xxxxxxxxxxxxx
Usage
Paystack-lite make use of blade directive to abstract away all javascript configurations for setting up paystack checkout forms.
Paystack Popup Example
Include the Blade Directive (@paystack
) somewhere in your template before your main application JavaScript is loaded.
The @paystack
blade directive creates payWithPaystack(amount, email, meta, onPaymentCompleted, onPaymentCancelled)
JavaScript helper which takes five parameters. the amount, customer email, meta data, callback for payment completed and callback when checkout form is closed.
var amount = 1000; var email = 'customer@email.com'; var meta = { /* optional meta data array */ }; document.getElementById('paymentBtn').onclick = function() { //display checkout form payWithPaystack(amount, email, meta, onPaymentCompleted, onPaymentCancelled); }; function onPaymentCompleted(response) { alert('payment completed!'); console.log(resposne); } function onPaymentCancelled() { alert('payment cancelled!'); }
Paystack Emebeded Example
Include the paystack embeded blade directive inside of your html container
<div> @paystackEmbeded(1000, 'onPaymentCompleted', 'customer@email.com') </div>
Add your javascript callback function
function onPaymentCompleted(response) { alert('payment completed!'); console.log(resposne); }
Paystack Fluent APIs
This package makes use of bosunski/lpaystack package. So you can use all paystack fluent APIs provided in the package.
Usage
use Stephenjude\PaystackLite\Facades\PaystackLite; /** * This gets all your transactions */ PaystackLite::api()->transactions()->list(); /** * This verifies a transaction with transaction reference passed as parameter */ PaystackLite::api()->transactions()->verify($ref); /** * This gets all your paystack customers. */ PaystackLite::api()->customers()->list(); /** * This gets all the plans that you have registered on Paystack */ PaystackLite::api()->plans()->list();
See the supported Paystack APIs here.
Changelog
Please see CHANGELOG for more information what has changed recently.
Security
If you discover any security related issues, please email stephen@ahoba.org.ng instead of using the issue tracker.
License
The MIT License (MIT). Please see License File for more information.