Download the PHP package paynecta/paynecta-laravel-sdk without Composer

Paynecta Laravel SDK

Official Laravel SDK for Paynecta Payment API - Simplify M-Pesa, Bank, and Wallet payment integrations in Kenya.

Features

• 🚀 Easy Integration - Get started in minutes with simple configuration
• 💳 M-Pesa STK Push - Trigger payment prompts directly on customer phones
• 💰 Payment Links - Create and manage shareable payment pages
• 🏦 Bank Integration - Access all available banks and their paybill numbers
• 🔔 Real-time Webhooks - Instant notifications for payment events
• 🛡️ Secure Authentication - API key and email-based authentication
• 📝 Comprehensive Logging - Debug with detailed request/response logs
• ⚡ Exception Handling - Graceful error handling with specific exceptions
• 🎯 Laravel Events - Native Laravel event system for webhooks

Requirements

• PHP 8.1 or higher
• Laravel 10.x or 11.x
• Guzzle HTTP Client 7.x

Installation

Install the package via Composer:

Publish Configuration

Publish the configuration file to customize settings:

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

Environment Configuration

Add your Paynecta credentials to your .env file:

⚠️ Security Note: Never commit your API credentials to version control. Always use environment variables.

Getting Your API Credentials

1. Log in to your Paynecta Dashboard
2. Navigate to /api section
3. Click "Create New API Key"
4. Copy your API key immediately (it's shown only once!)
5. Store it securely in your .env file

Quick Start

Verify Authentication

Test your credentials and retrieve user information:

Usage Guide

1. Payment Links

2. Initialize Payments (M-Pesa STK Push)

3. Query Payment Status

4. Currency Rates

5. Banks

6. Webhooks

Setup Webhook URL

Your webhook URL will be automatically registered at:

Add to your dashboard at: https://paynecta.co.ke

Whitelist Webhook Route (Important!)

Add to app/Http/Middleware/VerifyCsrfToken.php:

Listen to Webhook Events

Create event listeners:

In app/Listeners/HandlePaymentCompleted.php:

Register in app/Providers/EventServiceProvider.php:

Complete Payment Flow Example

Configuration Options

The package uses the following configuration options (in config/paynecta.php):

Advanced Usage

Dependency Injection

Custom Timeout

Enable Logging

Custom Base URL (Testing)

Exception Handling

The SDK throws specific exceptions for different error types:

Exception Methods

All Paynecta exceptions provide these methods:

Testing

Testing Webhooks Locally

Use ngrok to expose your local server:

Copy the HTTPS URL and add to your Paynecta dashboard:

Manual Testing

API Reference

Authentication

• verifyAuth() - Verify API credentials and get user info

Payment Links

• paymentLinks()->getAll() - Get all payment links
• paymentLinks()->get($code) - Get specific link
• paymentLinks()->getInvoices() - Get invoice links only
• paymentLinks()->getRegularLinks() - Get non-invoice links
• paymentLinks()->search($term) - Search links
• paymentLinks()->count() - Get total count

Payments

• payments()->initialize($code, $mobile, $amount) - Initialize STK push
• payments()->initializeWithValidation($code, $mobile, $amount) - Initialize with validation
• payments()->queryStatus($reference) - Query payment status
• payments()->pollStatus($reference, $maxAttempts, $sleepSeconds) - Poll until complete
• payments()->isCompleted($response) - Check if completed
• payments()->isPending($response) - Check if pending
• payments()->isFailed($response) - Check if failed
• payments()->getMpesaReceiptNumber($response) - Get receipt number
• payments()->getFailureReason($response) - Get failure reason

Banks

• banks()->getAll() - Get all banks
• banks()->get($bankId) - Get specific bank
• banks()->search($term) - Search banks
• banks()->findByName($name) - Find by exact name
• banks()->findByPaybill($paybill) - Find by paybill number
• banks()->getForDropdown() - Get for select dropdown
• banks()->getAllAsList() - Get as simple list
• banks()->getGroupedByLetter() - Get grouped by first letter

Currency Rates

• currencyRates()->getAll() - Get all currency rates (160+ currencies)
• currencyRates()->get($currency) - Get specific currency rate
• currencyRates()->convert($amount, $from, $to, $date) - Convert currency amounts
• currencyRates()->getHistory($from, $to, $startDate, $endDate) - Get historical rates
• currencyRates()->getRate($response) - Extract rate from response
• currencyRates()->getConvertedAmount($response) - Extract converted amount
• currencyRates()->getRates($response) - Extract rates array

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

Credits

• Paynecta
• All Contributors

License

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

Support

• 📧 Email: [email protected]
• 🌐 Website: https://paynecta.co.ke
• 📖 Documentation: https://paynecta.co.ke/docs
• 💬 Support: https://paynecta.co.ke/support

Made with ❤️ by Paynecta