README

A unified, extensible PHP Composer package for integrating with 18 payment gateways (Middle East + Iraq + Europe + International). Built with clean architecture, full API coverage, zero external dependencies, and enterprise-grade security.

Table of Contents

• Supported Gateways
• Installation
• Quick Start
• Factory Pattern
• Feature Matrix
• Documentation
• Testing
• Contributing
• License

Supported Gateways

MyFatoorah	Paylink	EdfaPay	Tap	ClickPay
Tamara	Thawani	Fatora	Payzaty	Payzah
Stripe	PayPal	NeonPay	AsiaPay	ZainCash
Mollie	Redsys	GoCardless

79 PHP classes across 18 gateways organized in 3 regions: International/, MiddleEast/, Europe/

Installation

composer require azozzalfiras/payment-gateway

Quick Start

use AzozzALFiras\PaymentGateway\PaymentGateway;
use AzozzALFiras\PaymentGateway\Enums\Gateway;
use AzozzALFiras\PaymentGateway\Enums\PaymentStatus;
use AzozzALFiras\PaymentGateway\DTOs\PaymentRequest;
use AzozzALFiras\PaymentGateway\DTOs\Customer;

// Create gateway from enum
$gateway = PaymentGateway::create(Gateway::TAP->value, [
    'secret_key' => 'sk_test_xxx',
    'testMode'   => true,
]);

// Or use typed static factory
$gateway = PaymentGateway::stripe(['secret_key' => 'sk_test_xxx', 'testMode' => true]);

// Purchase
$response = $gateway->purchase(new PaymentRequest(
    amount:      100.00,
    currency:    'SAR',
    orderId:     'ORDER-001',
    description: 'Premium Plan',
    callbackUrl: 'https://yoursite.com/callback',
    customer:    new Customer(name: 'Ahmed', email: 'ahmed@example.com'),
));

// Redirect customer to payment page
header("Location: {$response->paymentUrl}");

// Check payment status
$status = $gateway->status($response->transactionId);

// Gateway metadata from enum
echo Gateway::TAP->label();           // "Tap Payments"
echo Gateway::TAP->region();          // "MiddleEast"
echo Gateway::TAP->supportsRefund();  // true
echo Gateway::TAP->countries();       // ['KWT', 'SAU', 'ARE', ...]

Factory Pattern

use AzozzALFiras\PaymentGateway\PaymentGateway;

// 1. Generic factory — accepts any driver name string
$gateway = PaymentGateway::create('tap', ['secret_key' => '...']);

// 2. Typed static factory — full IDE autocomplete per gateway
$gateway = PaymentGateway::myfatoorah([...]);
$gateway = PaymentGateway::paylink([...]);
$gateway = PaymentGateway::edfapay([...]);
$gateway = PaymentGateway::tap([...]);
$gateway = PaymentGateway::clickpay([...]);
$gateway = PaymentGateway::tamara([...]);
$gateway = PaymentGateway::thawani([...]);
$gateway = PaymentGateway::fatora([...]);
$gateway = PaymentGateway::payzaty([...]);
$gateway = PaymentGateway::payzah([...]);
$gateway = PaymentGateway::stripe([...]);
$gateway = PaymentGateway::paypal([...]);
$gateway = PaymentGateway::neonpay([...]);
$gateway = PaymentGateway::asiapay([...]);
$gateway = PaymentGateway::zaincash([...]);
$gateway = PaymentGateway::mollie([...]);
$gateway = PaymentGateway::redsys([...]);
$gateway = PaymentGateway::gocardless([...]);

// List all 18 available driver names
PaymentGateway::getAvailableDrivers();

Feature Matrix

Feature
Purchase	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
Status	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
Refund	✅	—	✅	✅	✅	✅	—	✅	—	—	✅	✅	✅	✅	—	✅	✅	✅
Recurring	—	—	✅	✅	✅	—	✅	✅	—	—	✅	—	—	—	—	—	—	—
Auth/Capture	✅	—	✅	✅	✅	✅	—	—	—	—	✅	✅	—	—	—	—	—	—
Customer CRUD	✅	—	—	✅	—	—	✅	—	—	—	✅	—	—	—	—	✅	—	—
Direct Debit	—	—	—	—	—	—	—	—	—	—	—	—	—	—	—	—	—	✅
Webhook	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅

Documentation

Testing

composer install
composer test       # PHPUnit
composer analyse    # PHPStan Level 5

Current test results:

• PHPUnit: 135 tests, 281 assertions — all passing
• PHP Lint: all files — zero syntax errors
• PHPStan Level 5: 0 errors

Contributing

We welcome pull requests! Whether you're adding a new payment gateway, fixing bugs, or improving documentation.

See CONTRIBUTING.md for detailed guidelines on:

• How to add a new gateway (file structure, contracts, registration)
• Code style (PHP 8.1+, PSR-12, strict types)
• Testing requirements
• PR process

License

MIT License — see LICENSE file.

Author

AzozzALFiras — GitHub