Download the PHP package bryceandy/laravel_pesapal without Composer

Pesapal package for Laravel apps

This package enables Laravel developers to easily make use of the Pesapal API.

Version support

Installation

Pre-installation requirements

• A running or newly installed Laravel 7.* or above
• PHP 7.4 or above
• cURL extension installed

Now run

Configuration

Next we publish the configuration file that comes with the package

After publishing, you will find a pesapal.php file in your config directory

Head over to demo if you want a testing environment or live for a live integration and create a business account. You will obtain a key-secret pair for your integration

Inside your .env file, create these environment variables and they will be used to set configuration values available in the published config/pesapal.php file

Use the keys you obtained from Pesapal to fill the key and secret. If you are on a live account, set the is_live variable to true.

Thereafter, run the migration command as the package will load a database migration that stores the payment records

Usage

Before making a payment, setup a callback page.

Create a callback page and register its URL in the PESAPAL_CALLBACK_URL environment variable. This can be something like http://yourwebsite.com/callback

Once a payment process has been completed by the user, Pesapal will redirect to your site using the url.

Making a request to Pesapal for a payment.

Pesapal requires a request sent to their API in order to display the form like the one we see above

This package comes with a route /pesapal/iframe where you can post the data as follows:

For the type field, leave the default as MERCHANT. If you use ORDER, be sure to read the Pesapal documentation first.

When the data is posted successfully, you will have a view of the form to make payments.

A new payment record will be recorded in your pesapal_payments table, now you can choose the payment option you prefer.

Fetching the payment status.

After making the payment you will be redirected to the callback URL as mentioned above, and Pesapal will redirect with two query parameters:

• pesapal_merchant_reference – this is the same as $reference that you posted to Pesapal
• pesapal_transaction_tracking_id - a unique id for the transaction on Pesapal that you can use to track the status of the transaction later

With these two we can now:

A. Use these parameters to query the payment status to display to the user.

Normally on your callback page you can display whatever you need to your customer to show that the payment is being processed.

But because Pesapal will send the payment tracking Id which you have not recorded, you can save this unique tracking Id for your payment and also query for the payment status.

In the controller method where you display the callback page, query the status:

This way requires you to refresh the page because you may not know when the status has changed.

If this does not have a good user experience, you may setup an 'IPN listener' where Pesapal notifies you when a payment status has changed.

B. Setting up an IPN (Instant Payment Notifications) listener.

This only applies to merchant accounts. Create a route for your IPN listener, for example a GET request to /pesapal-ipn-listener

Your IPN Controller could look like this:

This controller method will be called every time Pesapal sends you an IPN notification until the payment is completed or has failed.

IMPORTANT

Register IPN settings

On your Pesapal dashboard find your Account Settings and click IPN Settings.

Fill in your website domain for example yourWebsite.com and IPN listener URL, for example yourWebsite.co.tz/pesapal-ipn-listener.

This is important so that Pesapal can send IPN notifications.

License

MIT License.

Contributors

This package is based from the PHP API of Pesapal

• BryceAndy > [email protected]

Sponsorship

If you enjoy using this package, consider contributing to the maintainer