taitech/azampay

A Laravel package for integrating your application with AzamPay payment services

1.1.1 2025-08-19 16:49 UTC

Requires

• php: ^8.1
• guzzlehttp/guzzle: ^7.5
• illuminate/config: ^9.0|^10.0|^11.0
• illuminate/http: ^9.0|^10.0|^11.0
• illuminate/routing: ^9.0|^10.0|^11.0
• illuminate/support: ^9.0|^10.0|^11.0
• spatie/laravel-activitylog: ^4.0

Suggests

• laravel/framework: Required for Laravel integration

Conflicts

• laravel/framework: <9.0

MIT

• Aman Simon Tairo

• payment
• laravel
• Bank
• merchant
• mobile-money
• tanzania
• azampay
• mno

README

A robust PHP package for seamless integration with Azampay payment services, supporting Mobile Money (MNO), Bank, and Merchant payment options.

Features

• Mobile Money (MNO) payments integration
• Bank payments processing
• Merchant services support
• Environment switching (Sandbox/Production)
• Simple credential management
• Flexible service selection
• Laravel 9.x, 10.x, 11.x, and 12.x support
• Automatic service discovery and registration
• Built-in facades and dependency injection
• Spatie Activity Log integration for database logging
• Comprehensive payment event tracking

Installation

Standard Installation

composer require taitech/azampay

Requirements

• PHP: ^8.1
• Laravel: ^9.0|^10.0|^11.0|^12.0
• GuzzleHTTP: ^7.5

Laravel Integration

This package is designed to work seamlessly with Laravel applications. For detailed Laravel integration instructions, see LARAVEL_INTEGRATION.md.

Quick Laravel Setup:

1. Install the package: composer require taitech/azampay
2. Publish configuration: php artisan vendor:publish --tag=azampay-config
3. Add environment variables to your .env file
4. Include routes: require base_path('routes/azampay.php');

Laravel Usage Examples:

// Using the Facade
use Taitech\Azampay\Facades\Azampay;
$response = Azampay::checkout($payload);

// Using the Service Container
$azampay = app('azampay');
$response = $azampay->checkout($payload);

// Using Dependency Injection
public function __construct(private AzampayService $azampay) {}
$response = $this->azampay->checkout($payload);

Quick Start

use Taitech\Azampay\AzampayService;

// Initialize the service
$azampay = new AzampayService(
    appName: 'YOUR_APP_NAME',
    clientId: 'YOUR_CLIENT_ID',
    secret: 'YOUR_CLIENT_SECRET',
    env: 'SANDBOX', // or 'PRODUCTION'
    service: 'MNO' // or 'BANK' or 'MERCHANT'
);

Configuration

The package requires the following configuration parameters:

• appName: Your application name registered with Azampay
• clientId: Your Azampay client ID
• secret: Your Azampay client secret
• env: Environment setting (SANDBOX or PRODUCTION)
• service: Service type (MNO, BANK, or MERCHANT)

Service Types

Mobile Money (MNO)

$azampay = new AzampayService(
    appName: 'YOUR_APP_NAME',
    clientId: 'YOUR_CLIENT_ID',
    secret: 'YOUR_CLIENT_SECRET',
    env: 'SANDBOX', // or 'PRODUCTION'
    service: 'MNO'
);

Bank Payments

$azampay = new AzampayService(
    appName: 'YOUR_APP_NAME',
    clientId: 'YOUR_CLIENT_ID',
    secret: 'YOUR_CLIENT_SECRET',
    env: 'SANDBOX', // or 'PRODUCTION'
    service: 'BANK'
);

Merchant Services

$azampay = new AzampayService(
    appName: 'YOUR_APP_NAME',
    clientId: 'YOUR_CLIENT_ID',
    secret: 'YOUR_CLIENT_SECRET',
    env: 'SANDBOX', // or 'PRODUCTION'
    service: 'MERCHANT'
);

Usage

Initiate Payment and Checkout

// vendor credentials
$app = 'YOUR_APP_NAME';
$clientId = 'YOUR_CLIENT_ID';
$secret = 'YOUR_SECRET_KEY';


try {
     $azampay = new AzampayService(
        $app, // App Name
        $clientId, // Client ID
        $secret, // Client Secret
        'SANDBOX', // Environment (SANDBOX/PRODUCTION)
        'MNO', // Service (MNO, BANK, MERCHANT)
    );

    // Example of calling the checkout method for MNO [MOBILE PAYMENT]
    $payload = [
        'amount' => 5000,
        'accountNumber' => '255713295803',
        'provider' => 'Tigo',
        'additionalProperties' => [
                'router' => "Home",
                'mac' => "A6:47:F6:52:38:D5",
            ],
    ];

    $response = $azampay->checkout($payload);

    // Output the final JSON response
    header('Content-Type: application/json');
    echo json_encode($response, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);

} catch (Exception $e) {
    echo "Error: " . $e->getMessage();
}

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/your-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin feature/your-feature)
5. Create a new Pull Request
6. Ensure your code adheres to the project's coding standards
7. Provide clear and concise commit messages

For more details, please refer to the CONTRIBUTING file.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For any issues or questions, please open an issue on the GitHub repository.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.1.0] - 2024-12-19

Added

• Laravel 12.x compatibility and support
• Enhanced version compatibility across Laravel 9.x, 10.x, 11.x, and 12.x

[1.0.0] - 2024-01-01

Added

• Initial release
• Support for Mobile Money (MNO) payments
• Support for Bank payments
• Support for Merchant services
• Environment switching capability
• Flexible service selection