Download the PHP package scwar/laravel-monnify-sdk without Composer

Laravel Monnify SDK

A comprehensive Laravel package for integrating with the Monnify payment gateway. This package provides a clean, fluent interface for handling transactions, invoices, subaccounts, and webhooks.

Features

• ✅ Complete Monnify API coverage (Transactions, Invoices, Subaccounts)
• ✅ Automatic token management with caching
• ✅ Webhook handling with signature verification
• ✅ Laravel Events for transaction status changes
• ✅ Database migrations for storing transactions/invoices locally
• ✅ Type-safe DTOs for all API responses
• ✅ Facade support for clean, expressive API
• ✅ Comprehensive exception handling
• ✅ Full test coverage structure

Requirements

• PHP >= 8.1 (PHP 8.2+ required for Laravel 12; PHP 8.3+ required for Laravel 13)
• Laravel >= 10.0, >= 11.0, >= 12.0, or >= 13.0
• Guzzle HTTP Client

Installation

Install the package via Composer:

Publish Configuration

Publish the configuration file:

This will create a config/monnify.php file in your application.

Publish Migrations

Publish the database migrations:

Run the migrations:

Environment Variables

Add the following environment variables to your .env file:

For sandbox/testing, use:

Configuration

The configuration file is located at config/monnify.php. You can customize:

• API credentials
• Base URL (sandbox/production)
• Webhook secret key
• Cache configuration
• Database table names
• Route prefix and middleware
• Default transaction/invoice settings

Usage

Using the Facade

The package provides a facade for easy access:

Transactions

Initialize a Transaction

Get Transaction Status

Verify Transaction

Refund Transaction

Query Transaction History

Invoices

Create an Invoice

Get Invoice Details

Cancel Invoice

List Invoices

Subaccounts

Create Subaccount

Update Subaccount

Delete Subaccount

Get Subaccount Details

List Subaccounts

Webhooks

The package automatically sets up webhook routes. By default, the webhook endpoint is:

You can customize this in the configuration file.

Webhook Events

The package automatically handles the following webhook events:

• SUCCESSFUL_TRANSACTION - Fires TransactionCompleted event
• FAILED_TRANSACTION - Fires TransactionFailed event
• OVERPAYMENT - Fires TransactionFailed event
• PARTIAL_OVERPAYMENT - Fires TransactionFailed event
• INVOICE_UPDATE - Updates invoice record

Listening to Events

You can listen to the events in your EventServiceProvider:

Example listener:

Webhook Signature Verification

The package automatically verifies webhook signatures using HMAC SHA512. Make sure to set MONNIFY_WEBHOOK_SECRET in your .env file.

Models

The package provides Eloquent models for transactions and invoices:

MonnifyTransaction

MonnifyInvoice

Exceptions

The package provides custom exceptions:

• Scwar\Monnify\Exceptions\MonnifyException - Base exception
• Scwar\Monnify\Exceptions\AuthenticationException - Authentication errors
• Scwar\Monnify\Exceptions\RequestException - API request errors

Example:

Testing

Run the tests:

Or using PHPUnit directly:

API Documentation

For complete API documentation, visit the Monnify Developer Documentation.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This package is open-sourced software licensed under the MIT license.

Support

For issues and questions, please open an issue on GitHub.

Changelog

Please see CHANGELOG for more information on what has changed recently.