Installation

composer require unicodeveloper/laravel-paystack

"unicodeveloper/laravel-paystack": "1.0.*"

'providers' => [    ...Unicodeveloper\Paystack\PaystackServiceProvider::class,    ...]

'aliases' => [    ...'Paystack' =>Unicodeveloper\Paystack\Facades\Paystack::class,    ...]

Configuration

php artisan vendor:publish --provider="Unicodeveloper\Paystack\PaystackServiceProvider"

<?phpreturn [/**     * Public Key From Paystack Dashboard     *     */'publicKey' =>getenv('PAYSTACK_PUBLIC_KEY'),/**     * Secret Key From Paystack Dashboard     *     */'secretKey' =>getenv('PAYSTACK_SECRET_KEY'),/**     * Paystack Payment URL     *     */'paymentUrl' =>getenv('PAYSTACK_PAYMENT_URL'),/**     * Optional email address of the merchant     *     */'merchantEmail' =>getenv('MERCHANT_EMAIL'),];

General payment flow

1. The customer is redirected to the payment provider

2. The customer pays on the site of the payment provider

3. The customer gets redirected back to your site

Usage

PAYSTACK_PUBLIC_KEY=xxxxxxxxxxxxxPAYSTACK_SECRET_KEY=xxxxxxxxxxxxxPAYSTACK_PAYMENT_URL=https://api.paystack.coMERCHANT_EMAIL=unicodeveloper@gmail.com

// Laravel 5.1.17 and aboveRoute::post('/pay','PaymentController@redirectToGateway')->name('pay');

Route::post('/pay', ['uses' =>'PaymentController@redirectToGateway','as' =>'pay']);

// Laravel 8 & 9Route::post('/pay', [App\Http\Controllers\PaymentController::class,'redirectToGateway'])->name('pay');

Route::get('/payment/callback','PaymentController@handleGatewayCallback');

// Laravel 5.0Route::get('payment/callback', ['uses' =>'PaymentController@handleGatewayCallback']);

// Laravel 8 & 9Route::get('/payment/callback', [App\Http\Controllers\PaymentController::class,'handleGatewayCallback']);

<?phpnamespaceApp\Http\Controllers;useIlluminate\Http\Request;useApp\Http\Requests;useApp\Http\Controllers\Controller;useIlluminate\Support\Facades\Redirect;usePaystack;class PaymentControllerextends Controller{/**     * Redirect the User to Paystack Payment Page     * @return Url     */publicfunctionredirectToGateway()    {try{return Paystack::getAuthorizationUrl()->redirectNow();        }catch(\Exception$e) {return Redirect::back()->withMessage(['msg'=>'The paystack token has expired. Please refresh the page and try again.','type'=>'error']);        }            }/**     * Obtain Paystack payment information     * @return void     */publicfunctionhandleGatewayCallback()    {$paymentDetails = Paystack::getPaymentData();dd($paymentDetails);// Now you have the payment details,// you can store the authorization_code in your db to allow for recurrent subscriptions// you can then redirect or do whatever you want    }}

/** *  In the case where you need to pass the data from your *  controller instead of a form *  Make sure to send: *  required: email, amount, reference, orderID(probably) *  optionally: currency, description, metadata *  e.g: * */$data =array("amount" =>700 *100,"reference" =>'4g4g5485g8545jg8gj',"email" =>'user@mail.com',"currency" =>"NGN","orderID" =>23456,    );return Paystack::getAuthorizationUrl($data)->redirectNow();

/** *  This fluent method does all the dirty work of sending a POST request with the form data *  to Paystack Api, then it gets the authorization Url and redirects the user to Paystack *  Payment Page. We've abstracted all of it, so you don't have to worry about that. *  Just eat your cookies while coding! */Paystack::getAuthorizationUrl()->redirectNow();/** * Alternatively, use the helper. */paystack()->getAuthorizationUrl()->redirectNow();/** * This fluent method does all the dirty work of verifying that the just concluded transaction was actually valid, * It verifies the transaction reference with Paystack Api and then grabs the data returned from Paystack. * In that data, we have a lot of good stuff, especially the `authorization_code` that you can save in your db * to allow for easy recurrent subscription. */Paystack::getPaymentData();/** * Alternatively, use the helper. */paystack()->getPaymentData();/** * This method gets all the customers that have performed transactions on your platform with Paystack * @returns array */Paystack::getAllCustomers();/** * Alternatively, use the helper. */paystack()->getAllCustomers();/** * This method gets all the plans that you have registered on Paystack * @returns array */Paystack::getAllPlans();/** * Alternatively, use the helper. */paystack()->getAllPlans();/** * This method gets all the transactions that have occurred * @returns array */Paystack::getAllTransactions();/** * Alternatively, use the helper. */paystack()->getAllTransactions();/** * This method generates a unique super secure cryptographic hash token to use as transaction reference * @returns string */Paystack::genTranxRef();/** * Alternatively, use the helper. */paystack()->genTranxRef();/*** This method creates a subaccount to be used for split payments* @return array*/Paystack::createSubAccount();/** * Alternatively, use the helper. */paystack()->createSubAccount();/*** This method fetches the details of a subaccount* @return array*/Paystack::fetchSubAccount();/** * Alternatively, use the helper. */paystack()->fetchSubAccount();/*** This method lists the subaccounts associated with your paystack account* @return array*/Paystack::listSubAccounts();/** * Alternatively, use the helper. */paystack()->listSubAccounts();/*** This method Updates a subaccount to be used for split payments* @return array*/Paystack::updateSubAccount();/** * Alternatively, use the helper. */paystack()->updateSubAccount();

<?php// more details https://paystack.com/docs/payments/multi-split-payments/#dynamic-splits$split = ["type" =>"percentage","currency" =>"KES","subaccounts" => [    ["subaccount" =>"ACCT_li4p6kte2dolodo","share" =>10 ],    ["subaccount" =>"ACCT_li4p6kte2dolodo","share" =>30 ],   ],"bearer_type" =>"all","main_account_share" =>70];?>

<formmethod="POST"action="{{ route('pay') }}"accept-charset="UTF-8"class="form-horizontal"role="form"><divclass="row"style="margin-bottom:40px;"><divclass="col-md-8 col-md-offset-2"><p><div>                    Lagos Eyo Print Tee Shirt                    ₦ 2,950</div></p><inputtype="hidden"name="email"value="otemuyiwa@gmail.com"> {{-- required --}}<inputtype="hidden"name="orderID"value="345"><inputtype="hidden"name="amount"value="800"> {{-- required in kobo --}}<inputtype="hidden"name="quantity"value="3"><inputtype="hidden"name="currency"value="NGN"><inputtype="hidden"name="metadata"value="{{ json_encode($array = ['key_name' => 'value',]) }}"> {{-- For other necessary things you want to add to your payload. it is optional though --}}<inputtype="hidden"name="reference"value="{{ Paystack::genTranxRef() }}"> {{-- required --}}<inputtype="hidden"name="split_code"value="SPL_EgunGUnBeCareful"> {{-- to support transaction split. more details https://paystack.com/docs/payments/multi-split-payments/#using-transaction-splits-with-payments --}}<inputtype="hidden"name="split"value="{{ json_encode($split) }}"> {{-- to support dynamic transaction split. More details https://paystack.com/docs/payments/multi-split-payments/#dynamic-splits --}}            {{ csrf_field() }} {{-- works only when using laravel 5.1, 5.2 --}}<inputtype="hidden"name="_token"value="{{ csrf_token() }}"> {{-- employ this in place of csrf_field only in laravel 5.0 --}}<p><buttonclass="btn btn-success btn-lg btn-block"type="submit"value="Pay Now!"><iclass="fa fa-plus-circle fa-lg"></i> Pay Now!</button></p></div></div></form>

Card Number: 4123450131001381Expiry Date: any datein the futureCVV: 883

Todo

Contributing

How can I thank you?

License