Filament Payment Manager

https://github.com/amidesfahani/filament-payment-manager
Admin
A comprehensive Filament 4 plugin that manages Shetabit Payment gateways with a beautiful admin...
Tokens:23,741
Snippets:338
Trust Score:7.9
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Package via Composer

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Use this command to install the package and trigger auto-discovery of the service provider.

```bash
composer require amidesfahani/filament-payment-manager
```

--------------------------------

### Install Filament Payment Manager

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/00-index.md

Run these commands to install the package, publish assets, and run migrations.

```bash
composer require amidesfahani/filament-payment-manager
php artisan vendor:publish --provider="AmidEsfahani\FilamentPaymentManager\FilamentPaymentManagerServiceProvider"
php artisan migrate
```

--------------------------------

### Configuration Merge Example

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/06-payment-flow.md

Illustrates the input and output of the configuration merging process.

```php
'zarinpal' => [
    'mode' => 'normal',
    'currency' => 'T',
]
```

```json
{"merchantId": "uuid-123", "password": "secret"}
```

```php
[
    'mode' => 'normal',           // from defaults
    'currency' => 'T',            // from defaults
    'merchantId' => 'uuid-123',   // from database
    'password' => 'secret',       // from database
    'callbackUrl' => '...'        // from gateway override or config
]
```

--------------------------------

### Configure Environment Variables

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/03-configuration.md

Example of the .env file configuration for the payment manager.

```env
# Payment Manager Configuration
PAYMENT_CALLBACK_URL=https://yourdomain.com/payment/callback
PAYMENT_AUTO_LOAD_GATEWAYS=true
PAYMENT_DEFAULT_CURRENCY=T
PAYMENT_ENABLE_LOGGING=false
```

--------------------------------

### Configuration Precedence Example

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Demonstrates how configuration values are resolved from package defaults, published application files, and environment variables.

```php
// Package default
config('filament-payment-manager.auto_load_gateways') // -> true (from package)

// After publishing, application can override
// config/filament-payment-manager.php:
return [
    'auto_load_gateways' => false, // Override to false
];

config('filament-payment-manager.auto_load_gateways') // -> false (from application)

// Environment variable overrides config file
// .env: PAYMENT_AUTO_LOAD_GATEWAYS=false
config('filament-payment-manager.auto_load_gateways') // -> false (from .env)
```

--------------------------------

### Implement get Method

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Retrieves the plugin instance from the Filament container.

```php
public static function get(): static
{
    return filament(app(static::class)->getId());
}
```

```php
$plugin = FilamentPaymentManagerPlugin::get();
$pluginId = $plugin->getId();
```

--------------------------------

### Implement Custom HTML Redirect Template

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/02-types.md

Example template utilizing placeholders for payment gateway integration.

```html
<form method="{method}" action="{action}" id="payment">
    {inputs}
    <button type="submit">Complete Payment</button>
</form>
<script>document.getElementById('payment').submit();</script>
```

--------------------------------

### Gateway Configuration JSON Formats

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/04-database-schema.md

Examples of JSON structures used for storing driver-specific settings in the config column.

```json
{
    "merchantId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "password": "merchant_password",
    "mode": "normal",
    "currency": "T"
}
```

```json
{
    "clientId": "client_id_string",
    "clientSecret": "client_secret_string",
    "mode": "sandbox",
    "currency": "USD"
}
```

--------------------------------

### Include View Blade Directive

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Example of accessing a package view using the registered namespace.

```blade
@include('filament-payment-manager::redirect-form')
```

--------------------------------

### Get Driver Default Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Retrieves the default configuration array for a specific driver by its key.

```php
$defaults = DriverService::getDriverDefaultConfig('zarinpal');

// Returns:
// [
//     'mode' => 'normal',
//     'currency' => 'T',
// ]
```

--------------------------------

### Boot Method Implementation

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Loads package resources and defines publishable assets after all service providers are registered.

```php
public function boot(): void
{
    // Load migrations
    $this->loadMigrationsFrom(__DIR__ . '/../database/migrations');

    // Load views
    $this->loadViewsFrom(__DIR__ . '/../resources/views', 'filament-payment-manager');

    // Publish config
    $this->publishes([
        __DIR__ . '/../config/filament-payment-manager.php' 
            => config_path('filament-payment-manager.php'),
    ], 'filament-payment-manager-config');

    // Publish migrations
    $this->publishes([
        __DIR__ . '/../database/migrations' 
            => database_path('migrations'),
    ], 'filament-payment-manager-migrations');

    // Publish views
    $this->publishes([
        __DIR__ . '/../resources/views' 
            => resource_path('views/vendor/filament-payment-manager'),
    ], 'filament-payment-manager-views');
}
```

--------------------------------

### Implement boot Method

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Reserved hook method for future plugin initialization tasks.

```php
public function boot(Panel $panel): void
{
    // Currently empty - reserved for future functionality
}
```

--------------------------------

### Run Database Migrations

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Executes the migration to create the necessary payment_gateways table.

```bash
php artisan migrate
```

--------------------------------

### Get Active Gateways

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/00-index.md

Retrieves a list of enabled gateways and iterates through them to display their names and driver identifiers.

```php
$gateways = $paymentManager->getActiveGateways();

foreach ($gateways as $gateway) {
    echo "{$gateway->name} ({$gateway->driver})";
}
```

--------------------------------

### Implement make Method

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Factory method to instantiate the plugin, used within the panel configuration.

```php
public static function make(): static
{
    return app(static::class);
}
```

```php
// app/Providers/Filament/AdminPanelProvider.php
use AmidEsfahani\FilamentPaymentManager\FilamentPaymentManagerPlugin;

return $panel
    ->plugins([
        FilamentPaymentManagerPlugin::make(),
    ]);
```

--------------------------------

### Publish and include views

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Commands and directives for managing and rendering package views.

```bash
php artisan vendor:publish --tag="filament-payment-manager-views"
```

```blade
@include('filament-payment-manager::redirect-form')
```

--------------------------------

### Create a local payment

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/06-payment-flow.md

Initializes a payment using the local driver for testing purposes without requiring external credentials.

```php
$payment = $paymentManager->createPayment(5000, 'local');
```

--------------------------------

### Configure Info List Schema

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/05-filament-integration.md

Placeholder configuration for the detail view schema, currently returning an empty component array.

```php
public static function configure(Schema $schema): Schema
{
    return $schema->components([]);
}
```

--------------------------------

### Load Migrations Method

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Makes package migrations automatically discoverable.

```php
$this->loadMigrationsFrom(__DIR__ . '/../database/migrations');
```

--------------------------------

### Load Views Method

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Registers the package views namespace.

```php
$this->loadViewsFrom(__DIR__ . '/../resources/views', 'filament-payment-manager');
```

--------------------------------

### Create Payment with PaymentManagerService

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/06-payment-flow.md

Initializes a payment instance using either the default gateway or a specific driver.

```php
use AmidEsfahani\FilamentPaymentManager\Services\PaymentManagerService;
use Shetabit\Multipay\Invoice;

$paymentManager = app(PaymentManagerService::class);

// Create invoice (from Shetabit)
$invoice = new Invoice();
$invoice->amount(10000); // Amount in configured currency

// Option A: Use default gateway
$payment = $paymentManager->createPayment($invoice->getAmount());

// Option B: Specify a driver
$payment = $paymentManager->createPayment($invoice->getAmount(), 'zarinpal');
```

--------------------------------

### Execute Purchase and Render Redirect

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/06-payment-flow.md

Initiates the purchase process and generates the HTML redirect form for the user.

```php
try {
    $response = $payment->purchase($invoice, function($driver, $transactionId) {
        // Callback invoked with driver and transaction ID
        // Store transaction ID in your database for verification later
        Order::find($orderId)->update(['transaction_id' => $transactionId]);
    })
    ->pay()
    ->render();
    
    // $response contains the redirect form HTML
    return response($response)->header('Content-Type', 'text/html');
    
} catch (\Exception $e) {
    // Handle purchase error
    return redirect()->route('order.payment-failed')
        ->with('error', 'Payment initiation failed');
}
```

--------------------------------

### DOKU Gateway Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Configure the DOKU driver using client credentials.

```php
[
    'clientId' => 'doku_client',
    'clientSecret' => 'doku_secret',
]
```

--------------------------------

### Configure Payment Gateway Settings

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/09-examples.md

Define default gateway settings and sandbox modes in the configuration file after publishing.

```php
// config/filament-payment-manager.php (after publishing)
return [
    'default_currency' => 'T',
    
    'driver_defaults' => [
        'local' => [
            'callbackUrl' => '/payment/callback',
            'title' => 'Test Payment Gateway',
            'description' => 'Local testing gateway - no real charges',
        ],
        
        'zarinpal' => [
            'mode' => env('PAYMENT_MODE', 'sandbox'), // sandbox for testing
            'currency' => 'T',
        ],
        
        'paypal' => [
            'mode' => env('PAYMENT_MODE', 'sandbox'), // sandbox for testing
            'currency' => 'USD',
        ],
    ],
];
```

--------------------------------

### Publish Package Assets

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Commands to publish package assets, configurations, migrations, or views to the application.

```bash
# Publish all package assets
php artisan vendor:publish --provider="AmidEsfahani\FilamentPaymentManager\FilamentPaymentManagerServiceProvider"

# Publish only specific assets
php artisan vendor:publish --tag="filament-payment-manager-config"
php artisan vendor:publish --tag="filament-payment-manager-migrations"
php artisan vendor:publish --tag="filament-payment-manager-views"
```

--------------------------------

### Execute Basic Payment Flow

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/README.md

Initiate a payment using the PaymentManagerService, either via the default gateway or a specific driver.

```php
use YourVendor\FilamentPaymentManager\Services\PaymentManagerService;
use Shetabit\Multipay\Invoice;

// Get the service
$paymentManager = app(PaymentManagerService::class);

// Create an invoice
$invoice = new Invoice();
$invoice->amount(10000); // Amount in Toman or Rial

// Create payment (uses default gateway)
$payment = $paymentManager->createPayment($invoice->getAmount());

// Or specify a gateway
$payment = $paymentManager->createPayment($invoice->getAmount(), 'zarinpal');

// Purchase and get transaction ID
try {
    $transactionId = $payment->purchase($invoice, function($driver, $transactionId) {
        // Store transaction ID in your database
    })->pay()->render();
    
} catch (\Exception $e) {
    // Handle error
}
```

--------------------------------

### Configure local driver defaults

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/03-configuration.md

Sets default configuration for the local test payment gateway.

```php
'local' => [
    'callbackUrl' => env('PAYMENT_CALLBACK_URL', '/callback'),
    'title' => 'Test Payment Gateway',
    'description' => 'This gateway is for testing only',
],
```

--------------------------------

### Create Payment with Default Gateway

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/00-index.md

Initializes the payment manager service and creates a payment using the configured default gateway.

```php
$paymentManager = app(PaymentManagerService::class);
$payment = $paymentManager->createPayment(10000);
```

--------------------------------

### Instantiate FilamentPaymentManagerPlugin

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/01-api-reference.md

Use the make() factory method within the AdminPanelProvider to register the plugin.

```php
// In AdminPanelProvider
->plugins([
    FilamentPaymentManagerPlugin::make(),
])
```

--------------------------------

### Configure saman driver defaults

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/03-configuration.md

Sets default currency for the Saman Bank gateway.

```php
'saman' => [
    'currency' => 'T',  // Toman
],
```

--------------------------------

### Publishing Commands

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Artisan commands to publish package assets to the application.

```bash
php artisan vendor:publish --tag="filament-payment-manager-config"
```

```bash
php artisan vendor:publish --tag="filament-payment-manager-migrations"
```

```bash
php artisan vendor:publish --tag="filament-payment-manager-views"
```

--------------------------------

### Configure Select field

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/05-filament-integration.md

Creates a searchable dropdown with reactive behavior and custom state update hooks.

```php
Select::make('driver')
    ->label('Driver')
    ->required()
    ->options(DriverService::getAvailableDrivers())
    ->reactive()
    ->native(false)
    ->searchable()
    ->afterStateUpdated(fn ($state, callable $set) => ...)
```

--------------------------------

### Publish Plugin Assets

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Publishes configuration, migrations, and views to the application directory for customization.

```bash
php artisan vendor:publish --provider="AmidEsfahani\FilamentPaymentManager\FilamentPaymentManagerServiceProvider"
```

--------------------------------

### Local Test Gateway Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Configure the local test driver for simulating payment flows without real credentials.

```php
[
    'callbackUrl' => '/payment/callback',
    'title' => 'Test Payment Gateway',
    'description' => 'For testing only',
]
```

--------------------------------

### Register Method Implementation

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Merges the package configuration file with the application's configuration during the registration phase.

```php
public function register(): void
{
    $this->mergeConfigFrom(
        __DIR__ . '/../config/filament-payment-manager.php',
        'filament-payment-manager'
    );
}
```

--------------------------------

### Process Payment in Controller

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/09-examples.md

Initiate a payment by creating an invoice and rendering the redirect response.

```php
// app/Http/Controllers/CheckoutController.php
<?php

namespace App\Http\Controllers;

use AmidEsfahani\FilamentPaymentManager\Services\PaymentManagerService;
use App\Models\Order;
use Shetabit\Multipay\Invoice;

class CheckoutController extends Controller
{
    public function processPayment(Request $request, PaymentManagerService $paymentManager)
    {
        $validated = $request->validate([
            'order_id' => 'required|exists:orders,id',
        ]);

        $order = Order::findOrFail($validated['order_id']);

        // Check if order is already paid
        if ($order->is_paid) {
            return redirect()->route('order.show', $order)
                ->with('warning', 'Order already paid');
        }

        try {
            // Create invoice
            $invoice = new Invoice();
            $invoice->amount($order->total_amount); // Amount in configured currency
            
            // Create payment (uses default gateway)
            $payment = $paymentManager->createPayment($invoice->getAmount());

            // Purchase and get HTML for redirect
            $response = $payment->purchase($invoice, function($driver, $transactionId) use ($order) {
                // Store transaction ID for verification
                $order->update([
                    'transaction_id' => $transactionId,
                    'payment_driver' => $driver,
                    'payment_initiated_at' => now(),
                ]);
            })
            ->pay()
            ->render();

            // Return the redirect form to user
            return response($response)->header('Content-Type', 'text/html');

        } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $e) {
            return redirect()->route('checkout.form', $order)
                ->with('error', 'Payment gateway not configured');
        } catch (\Exception $e) {
            \Log::error('Payment processing failed: ' . $e->getMessage());
            return redirect()->route('checkout.form', $order)
                ->with('error', 'Payment processing failed. Please try again.');
        }
    }
}
```

--------------------------------

### Registering a Custom Driver

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Add custom driver configurations to the driver_defaults array in the package configuration file.

```php
'driver_defaults' => [
    // ... existing drivers ...
    'custom_driver' => [
        'apiKey' => env('CUSTOM_DRIVER_API_KEY'),
        'mode' => 'production',
    ],
]
```

--------------------------------

### Implement Multi-Gateway Selection and Processing

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/06-payment-flow.md

This snippet demonstrates the full flow of retrieving active gateways, rendering a selection form, and processing the chosen payment driver in a Laravel controller.

```php
// In controller
public function showPaymentGateways($orderId)
{
    $paymentManager = app(PaymentManagerService::class);
    $gateways = $paymentManager->getActiveGateways();
    
    return view('payment.choose-gateway', [
        'orderId' => $orderId,
        'gateways' => $gateways,
    ]);
}

// In Blade template
<form method="POST" action="{{ route('payment.process') }}">
    @csrf
    <input type="hidden" name="order_id" value="{{ $orderId }}">
    
    <select name="gateway_driver" required>
        <option value="">Select Payment Method</option>
        @foreach ($gateways as $gateway)
            <option value="{{ $gateway->driver }}">
                {{ $gateway->name }}
            </option>
        @endforeach
    </select>
    
    <button type="submit">Pay Now</button>
</form>

// In controller processing form
public function processPayment(Request $request)
{
    $validated = $request->validate([
        'order_id' => 'required|exists:orders,id',
        'gateway_driver' => 'required|string',
    ]);
    
    $paymentManager = app(PaymentManagerService::class);
    $order = Order::findOrFail($validated['order_id']);
    
    try {
        $payment = $paymentManager->createPayment(
            $order->amount,
            $validated['gateway_driver']
        );
        
        // Proceed with payment
        $html = $payment->purchase($invoice)->pay()->render();
        return response($html);
    } catch (\Exception $e) {
        return back()->with('error', 'Payment failed: ' . $e->getMessage());
    }
}
```

--------------------------------

### Configure enable_logging

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/03-configuration.md

Enables detailed logging for payment gateway requests and responses.

```php
'enable_logging' => true
```

--------------------------------

### Configuration Section Definition

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/05-filament-integration.md

Defines the configuration section using a KeyValue component.

```php
Section::make('Configuration')
└── KeyValue: config
    ├── Non-reorderable
    ├── Add action label: "Add Config"
    └── Full width (columnSpanFull)
```

--------------------------------

### Retrieve default driver configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/01-api-reference.md

Fetches the default configuration template for a given driver. Returns an empty array if the driver is null.

```php
public static function getDriverDefaultConfig(?string $driver): array
```

```php
$zarinpalDefaults = DriverService::getDriverDefaultConfig('zarinpal');
// Returns: ['mode' => 'normal', 'currency' => 'T', ...]
```

--------------------------------

### Implement register Method

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Registers the PaymentGatewayResource with the Filament panel.

```php
public function register(Panel $panel): void
{
    $panel->resources([
        PaymentGatewayResource::class,
    ]);
}
```

--------------------------------

### Package Dependencies

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/00-index.md

Lists the required PHP version and package dependencies for the project.

```json
{
    "php": "^8.1",
    "filament/filament": "^4.0",
    "shetabit/payment": "^6.0",
    "moneyphp/money": "^4.8",
    "spatie/laravel-package-tools": "^1.92.7"
}
```

--------------------------------

### Perfect Money Gateway Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Configure the Perfect Money driver using account number and passphrase.

```php
[
    'accountNumber' => 'U1234567',
    'passphrase' => 'payment_passphrase',
]
```

--------------------------------

### Configure paypal driver defaults

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/03-configuration.md

Sets default mode and currency for the PayPal international gateway.

```php
'paypal' => [
    'mode' => 'normal', // 'normal' or 'sandbox'
    'currency' => 'USD',
],
```

--------------------------------

### FilamentPaymentManagerPlugin::make()

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Factory method to instantiate the plugin for use in Filament panel configuration.

```APIDOC
## static make()

### Description
Factory method to instantiate the plugin. Returns a new instance from the service container.

### Usage
```php
// app/Providers/Filament/AdminPanelProvider.php
use AmidEsfahani\FilamentPaymentManager\FilamentPaymentManagerPlugin;

return $panel
    ->plugins([
        FilamentPaymentManagerPlugin::make(),
    ]);
```
```

--------------------------------

### Configure zarinpal driver defaults

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/03-configuration.md

Sets default configuration for the Zarinpal gateway, including mode and currency.

```php
'zarinpal' => [
    'mode' => 'normal', // 'normal', 'sandbox', or 'zaringate'
    'currency' => 'T',  // Toman
],
```

--------------------------------

### PayPal Gateway Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Configure the PayPal driver using OAuth credentials and specify the environment mode.

```php
[
    'clientId' => 'PayPal-Client-ID',
    'clientSecret' => 'PayPal-Client-Secret',
    'mode' => 'sandbox',
    'currency' => 'USD',
]
```

--------------------------------

### Initialize PaymentManagerService

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/01-api-reference.md

The constructor automatically loads active gateways from the database into the Laravel payment configuration.

```php
public function __construct()
```

--------------------------------

### Define Driver Configuration Structure

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/02-types.md

Represents the expected key-value array structure for payment driver configuration options.

```php
[
    'merchantId' => string,        // Merchant identifier
    'password' => string,          // Authentication credential
    'clientId' => string,          // OAuth client identifier
    'clientSecret' => string,      // OAuth client secret
    'secret' => string,            // API secret key
    'mode' => string,              // 'normal' or 'sandbox'
    'currency' => string,          // ISO currency code
    'callbackUrl' => string,       // Payment callback endpoint
    'title' => string,             // Payment title/description
    'success_url' => string,       // Success redirect URL
    'cancel_url' => string,        // Cancellation redirect URL
]
```

--------------------------------

### NOWPayments Gateway Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Configure the NOWPayments driver using an API key and IPN secret.

```php
[
    'apiKey' => 'nowpayments_api_key',
    'ipnSecret' => 'nowpayments_secret',
]
```

--------------------------------

### Configure Sandbox Mode

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Updates a payment gateway configuration to use sandbox mode for testing purposes.

```php
// Sandbox mode for testing
$gateway = PaymentGateway::find(1);
$gateway->config = array_merge(
    $gateway->config ?? [],
    ['mode' => 'sandbox']
);
$gateway->save();
```

--------------------------------

### Retrieving Supported Currencies

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Access the list of all ISO 4217 currency codes using the DriverService.

```php
$currencies = DriverService::currencies();

// Returns sorted array:
// ['AED' => 'AED', 'AFN' => 'AFN', ..., 'USD' => 'USD', ...]
```

--------------------------------

### Configure Environment Variables

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/00-index.md

Set these variables in your .env file to override default package settings.

```env
PAYMENT_CALLBACK_URL=https://yourdomain.com/payment/callback
PAYMENT_AUTO_LOAD_GATEWAYS=true
PAYMENT_DEFAULT_CURRENCY=T
PAYMENT_ENABLE_LOGGING=false
```

--------------------------------

### Set Gateway Currency

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Configures currency settings for Iranian and international payment gateways.

```php
$gateway->currency = 'T'; // Toman
$gateway->config = ['currency' => 'T'];
```

```php
$gateway->currency = 'USD'; // US Dollar
$gateway->config = ['currency' => 'usd']; // Stripe uses lowercase
```

--------------------------------

### Package dependencies

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Required core dependencies for the package.

```json
{
    "filament/filament": "^4.0",
    "shetabit/payment": "^6.0",
    "moneyphp/money": "^4.8"
}
```

--------------------------------

### Define driver_defaults structure

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/03-configuration.md

Shows the expected nested associative array structure for defining driver-specific configurations.

```php
'driver_defaults' => [
    'driver_name' => [
        'config_key' => 'default_value',
        // ...
    ],
]
```

--------------------------------

### Configure PaymentGatewayResource infolist

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/01-api-reference.md

Defines the infolist schema method for the PaymentGatewayResource.

```php
public static function infolist(Schema $schema): Schema
```

--------------------------------

### Configure navigation properties

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/05-filament-integration.md

Defines the icon, navigation group, and sort order for the resource in the admin sidebar.

```php
protected static string | BackedEnum | null $navigationIcon = Heroicon::OutlinedCreditCard;
protected static string | UnitEnum | null $navigationGroup = 'Settings';
protected static ?int $navigationSort = 10;
```

--------------------------------

### Resolve Gateway Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/06-payment-flow.md

Merges package defaults with database-stored gateway configuration.

```php
// In PaymentGateway model:
public function getConfigWithDefaults(): array
{
    $defaults = config("filament-payment-manager.driver_defaults.{$this->driver}", []);
    $config = $this->config ? (array) $this->config : [];
    
    return array_merge($defaults, $config);
}
```

--------------------------------

### Registering as a Singleton

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Configures the PaymentManagerService as a singleton within the application's service provider.

```php
// In your app's service provider
app()->singleton(PaymentManagerService::class, function () {
    return new PaymentManagerService();
});
```

--------------------------------

### DriverService::getDriverDefaultConfig(?string $driver)

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/01-api-reference.md

Retrieves the default configuration template for a specific payment driver.

```APIDOC
## DriverService::getDriverDefaultConfig(?string $driver)

### Description
Retrieves the default configuration template for a specific payment driver.

### Method
public static function getDriverDefaultConfig(?string $driver): array

### Parameters
- **$driver** (string|null) - Optional - Driver identifier. Returns empty array if null

### Returns
- **array** - Default configuration key-value pairs for the driver.
```

--------------------------------

### Test Payment Flow with Local Gateway

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/09-examples.md

Verify the payment flow by asserting the presence of the local gateway and checking the response during checkout.

```php
// tests/Feature/PaymentFlowTest.php
<?php

namespace Tests\Feature;

use App\Models\Order;
use AmidEsfahani\FilamentPaymentManager\Models\PaymentGateway;
use Tests\TestCase;

class PaymentFlowTest extends TestCase
{
    public function test_payment_flow_with_local_gateway()
    {
        // Ensure local gateway is active
        $gateway = PaymentGateway::where('driver', 'local')->first();
        $this->assertNotNull($gateway);
        $this->assertTrue($gateway->is_active);

        // Create order
        $order = Order::factory()->create(['total_amount' => 10000]);

        // Process payment
        $response = $this->post('/checkout/pay', [
            'order_id' => $order->id,
        ]);

        // Should get redirect form
        $response->assertStatus(200);
        $response->assertSee('<form');

        // Verify transaction ID stored
        $order->refresh();
        $this->assertNotNull($order->transaction_id);
    }
}
```

--------------------------------

### Register Filament Plugin

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/00-index.md

Add the plugin to your Filament panel configuration.

```php
// app/Providers/Filament/AdminPanelProvider.php
use AmidEsfahani\FilamentPaymentManager\FilamentPaymentManagerPlugin;

return $panel
    ->plugins([
        FilamentPaymentManagerPlugin::make(),
    ]);
```

--------------------------------

### Implement Payment Controller with Error Handling

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/09-examples.md

Use this controller structure to validate gateway configurations, process payments, and handle verification callbacks with specific catch blocks for different failure scenarios.

```php
// app/Http/Controllers/PaymentController.php
<?php

namespace App\Http\Controllers;

use AmidEsfahani\FilamentPaymentManager\Services\PaymentManagerService;
use App\Models\Order;
use Shetabit\Payment\Exceptions\PaymentException;
use Illuminate\Database\Eloquent\ModelNotFoundException;

class PaymentController extends Controller
{
    public function processPayment(Request $request, PaymentManagerService $paymentManager)
    {
        $validated = $request->validate([
            'order_id' => 'required|exists:orders,id',
        ]);

        $order = Order::findOrFail($validated['order_id']);

        try {
            // Verify gateway is configured
            $gateway = $paymentManager->getDefaultGateway();
            if (!$gateway) {
                throw new \RuntimeException('No payment gateway configured');
            }

            // Check gateway config is complete
            $config = $gateway->getConfigWithDefaults();
            if (empty($config['merchantId']) && !in_array($gateway->driver, ['local'])) {
                throw new \RuntimeException('Payment gateway not fully configured');
            }

            // Create and process payment
            $payment = $paymentManager->createPayment($order->total_amount);
            
            $html = $payment->purchase(
                $this->createInvoice($order),
                function($driver, $transactionId) use ($order) {
                    $order->update([
                        'transaction_id' => $transactionId,
                        'payment_driver' => $driver,
                    ]);
                }
            )->pay()->render();

            return response($html)->header('Content-Type', 'text/html');

        } catch (ModelNotFoundException $e) {
            \Log::warning('Payment gateway not found');
            return $this->failedPayment($order, 'Payment method not available');

        } catch (PaymentException $e) {
            \Log::error('Shetabit Payment error: ' . $e->getMessage());
            return $this->failedPayment($order, 'Payment processing error. Please try again.');

        } catch (\Exception $e) {
            \Log::error('Unexpected payment error: ' . $e->getMessage(), [
                'order_id' => $order->id,
                'exception' => $e,
            ]);
            return $this->failedPayment($order, 'An error occurred. Please contact support.');
        }
    }

    public function callback(Request $request, PaymentManagerService $paymentManager)
    {
        try {
            $receipt = $paymentManager->verifyPayment();
            return $this->handleSuccessfulPayment($receipt);

        } catch (PaymentException $e) {
            \Log::warning('Payment verification failed: ' . $e->getMessage());
            return $this->handleFailedVerification($e);

        } catch (\Exception $e) {
            \Log::error('Unexpected error in callback: ' . $e->getMessage());
            return redirect('/')->with('error', 'Payment processing error');
        }
    }

    private function failedPayment(Order $order, string $message)
    {
        $order->update(['status' => 'payment_failed']);
        return redirect()->route('checkout.form', $order)
            ->with('error', $message);
    }

    private function handleSuccessfulPayment($receipt)
    {
        $order = Order::where('transaction_id', $receipt->getTransactionId())->first();
        
        if (!$order) {
            \Log::warning('Receipt received for unknown transaction', [
                'transaction_id' => $receipt->getTransactionId(),
            ]);
            return redirect('/')->with('warning', 'Order not found');
        }

        $order->update([
            'is_paid' => true,
            'reference_id' => $receipt->getReferenceId(),
            'status' => 'confirmed',
        ]);

        return redirect()->route('order.success', $order)
            ->with('success', 'Payment successful!');
    }

    private function handleFailedVerification(PaymentException $e)
    {
        return redirect('/')->with('error', 'Payment verification failed: ' . $e->getMessage());
    }

    private function createInvoice(Order $order)
    {
        $invoice = new \Shetabit\Multipay\Invoice();
        $invoice->amount($order->total_amount);
        return $invoice;
    }
}
```

--------------------------------

### Define Payment Routes

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/09-examples.md

Register the checkout and callback routes in your web routes file.

```php
// routes/web.php
Route::post('/checkout/pay', [CheckoutController::class, 'processPayment'])->name('checkout.pay');
Route::get('/payment/callback', [PaymentController::class, 'callback'])->name('payment.callback');
```

--------------------------------

### Create Payment Object

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/01-api-reference.md

Creates a new payment object for a specified driver and amount. Throws a ModelNotFoundException if the driver is missing or no default is set.

```php
public function createPayment(float $amount, ?string $driver = null): \Shetabit\Multipay\Payment
```

```php
$paymentManager = app(PaymentManagerService::class);

// Using default gateway
$payment = $paymentManager->createPayment(10000);

// Using specific driver
$payment = $paymentManager->createPayment(5000, 'zarinpal');

// Chain with purchase
$transactionId = $payment->purchase($invoice)->pay()->render();
```

--------------------------------

### PayPing Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Configuration structure for the PayPing gateway.

```php
[
    'pin' => 'payping_api_key',
]
```

--------------------------------

### Retrieve Merged Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/02-types.md

Merges database-stored gateway configuration with driver-specific defaults.

```php
public function getConfigWithDefaults(): array
```

```php
$gateway = PaymentGateway::where('driver', 'zarinpal')->first();
$config = $gateway->getConfigWithDefaults();
// Config includes defaults from config/filament-payment-manager.php
// with database values merged on top
```

--------------------------------

### Configure default_currency

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/03-configuration.md

Sets the default currency to Toman for Iranian payment gateways.

```php
'default_currency' => 'T'
```

--------------------------------

### Enforce Single Default Gateway

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/02-types.md

Boot method hook that ensures only one gateway is marked as default at any time.

```php
protected static function booted(): void
{
    static::saving(function (PaymentGateway $gateway) {
        if ($gateway->is_default) {
            static::where('id', '!=', $gateway->id)
                ->where('is_default', true)
                ->update(['is_default' => false]);
        }
    });
}
```

--------------------------------

### Package Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Structure for the package configuration file located at config/filament-payment-manager.php.

```php
// config/filament-payment-manager.php
return [
    'default_callback_url' => env('PAYMENT_CALLBACK_URL'),
    'auto_load_gateways' => env('PAYMENT_AUTO_LOAD_GATEWAYS', true),
    // ... customize as needed
];
```

--------------------------------

### Define list page header action

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/05-filament-integration.md

Adds a create button with a specific icon to the list page header.

```php
CreateAction::make()->icon('heroicon-o-plus')
```

--------------------------------

### DriverService::currencies()

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/01-api-reference.md

Retrieves a list of all ISO 4217 currency codes.

```APIDOC
## DriverService::currencies()

### Description
Retrieves a list of all ISO 4217 currency codes.

### Method
public static function currencies(): array

### Returns
- **array** - Associative array mapping currency codes to themselves, sorted alphabetically.
```

--------------------------------

### Handle Payment Callback

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/09-examples.md

Verify the payment receipt and update the order status accordingly.

```php
// app/Http/Controllers/PaymentController.php
<?php

namespace App\
Http\Controllers;

use AmidEsfahani\FilamentPaymentManager\Services\PaymentManagerService;
use App\Models\Order;

class PaymentController extends Controller
{
    public function callback(Request $request, PaymentManagerService $paymentManager)
    {
        try {
            // Verify payment with payment gateway
            $receipt = $paymentManager->verifyPayment();

            // Payment successful - get receipt details
            $transactionId = $receipt->getTransactionId();
            $referenceId = $receipt->getReferenceId();

            // Find and update order
            $order = Order::where('transaction_id', $transactionId)->firstOrFail();
            
            $order->update([
                'is_paid' => true,
                'reference_id' => $referenceId,
                'payment_verified_at' => now(),
                'status' => 'confirmed',
            ]);

            // Send confirmation email
            Mail::send(new OrderConfirmed($order));

            return redirect()->route('order.success', $order)
                ->with('success', 'Payment completed successfully! Order confirmed.');

        } catch (\Exception $e) {
            \Log::warning('Payment verification failed: ' . $e->getMessage());

            // Update order to failed status
            if ($request->has('transaction_id')) {
                Order::where('transaction_id', $request->input('transaction_id'))
                    ->update(['status' => 'payment_failed']);
            }

            return redirect()->route('checkout.form')
                ->with('error', 'Payment verification failed. Please contact support.');
        }
    }
}
```

--------------------------------

### Configure KeyValue field

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/05-filament-integration.md

Provides a table-based interface for managing key-value configuration pairs.

```php
KeyValue::make('config')
    ->label('Gateway Configuration')
    ->keyLabel('Config Key')
    ->valueLabel('Config Value')
    ->reorderable(false)
    ->addActionLabel('Add Config')
    ->helperText('Configure gateway-specific settings')
```

--------------------------------

### Process Payments via Facade

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/03-configuration.md

Direct usage of the Shetabit Payment facade to initiate a transaction.

```php
use Shetabit\Payment\Facade\Payment;

$payment = Payment::via('zarinpal')->amount(10000);
$payment->purchase($invoice, function($driver, $transactionId) {
    // Handle transaction
})->pay()->render();
```

--------------------------------

### Create Payment Statistics Widget in Filament

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/09-examples.md

Extends StatsOverviewWidget to aggregate and display payment data from the database. Ensure the Order and PaymentGateway models are correctly configured in your application.

```php
// app/Filament/Widgets/PaymentStatsWidget.php
<?php

namespace Appilament\Widgets;

use App\Models\Order;
use Filament\Widgets\StatsOverviewWidget;
use Filament\Widgets\StatsOverviewWidget\Stat;
use AmidEsfahani\FilamentPaymentManager\Models\PaymentGateway;

class PaymentStatsWidget extends StatsOverviewWidget
{
    protected function getStats(): array
    {
        return [
            Stat::make(
                'Total Paid Orders',
                Order::where('is_paid', true)->count()
            )
            ->description('Orders with confirmed payments')
            ->icon('heroicon-o-check-circle'),

            Stat::make(
                'Pending Payments',
                Order::where('status', 'pending')->count()
            )
            ->description('Awaiting payment confirmation')
            ->icon('heroicon-o-hourglass'),

            Stat::make(
                'Active Gateways',
                PaymentGateway::where('is_active', true)->count()
            )
            ->description('Enabled payment methods')
            ->icon('heroicon-o-credit-card'),

            Stat::make(
                'Total Revenue',
                '$' . number_format(
                    Order::where('is_paid', true)->sum('total_amount') / 100,
                    2
                )
            )
            ->description('From paid orders')
            ->icon('heroicon-o-banknotes'),
        ];
    }
}
```

--------------------------------

### Create payment_gateways table migration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/04-database-schema.md

Defines the up method for the migration to create the payment_gateways table.

```php
public function up(): void
{
    Schema::create('payment_gateways', function (Blueprint $table) {
        // See column definitions above
    });
}
```

--------------------------------

### Validating Driver Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Verify that a driver is available and inspect its configuration settings during testing.

```php
// Test if driver is available and has required config
public function testDriverConfig($driverName)
{
    $defaults = DriverService::getDriverDefaultConfig($driverName);
    $gateway = PaymentGateway::where('driver', $driverName)->first();
    
    if (!$gateway) {
        echo "Gateway not created for driver: $driverName";
        return false;
    }
    
    $config = $gateway->getConfigWithDefaults();
    
    // Log config for inspection
    \Log::debug("Driver config for $driverName:", $config);
    
    return true;
}
```

--------------------------------

### Configure stripe driver defaults

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/03-configuration.md

Sets default currency for the Stripe international gateway.

```php
'stripe' => [
    'currency' => 'usd',
],
```

--------------------------------

### Define Custom HTML Redirect Template

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/README.md

Use placeholders for method, action, and inputs to create a custom HTML redirect form.

```html
<form method="{method}" action="{action}">
    {inputs}
    <button>Pay Now</button>
</form>
<script>document.forms[0].submit();</script>
```

--------------------------------

### Settings Section Definition

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/05-filament-integration.md

Defines the settings section for currency and status toggles.

```php
Section::make('Settings')
├── Select: currency
│   ├── Searchable, preload
│   ├── Options from DriverService::currencies()
│   └── Required
├── Toggle: is_active (default: true)
├── Toggle: is_default
├── TextInput: sort_order (numeric, default: 0)
```

--------------------------------

### Configure Stripe Gateway

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/README.md

Configuration array for the Stripe payment driver.

```php
[
    'secret' => 'sk_test_xxxxxxxxxxxxx',
    'currency' => 'usd',
    'success_url' => 'https://yourdomain.com/payment/success',
    'cancel_url' => 'https://yourdomain.com/payment/cancel',
]
```

--------------------------------

### Basic Information Section Definition

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/05-filament-integration.md

Defines the initial section for payment gateway basic information.

```php
Section::make('Basic Information')
├── TextInput: name (required, unique, maxLength: 255)
└── Select: driver (required, reactive)
    ├── Options from DriverService::getAvailableDrivers()
    ├── Searchable
    ├── Native: false (Filament UI)
    └── afterStateUpdated: loads default config for selected driver
```

--------------------------------

### Retrieve Available Drivers

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Fetches an associative array of all available payment drivers and their labels.

```php
use AmidEsfahani\FilamentPaymentManager\Services\DriverService;

$drivers = DriverService::getAvailableDrivers();

// Returns associative array of available drivers
// Example: 
// [
//     'zarinpal' => 'Zarinpal',
//     'stripe' => 'Stripe',
//     'paypal' => 'Paypal',
//     ...
// ]

foreach ($drivers as $driverName => $driverLabel) {
    echo "$driverName: $driverLabel";
}
```

--------------------------------

### createPayment

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/README.md

Creates a new payment instance.

```APIDOC
## createPayment($amount, $driver = null)

### Description
Create a new payment.

### Parameters
- **amount** (mixed) - Required - The payment amount.
- **driver** (string) - Optional - The payment driver name.
```

--------------------------------

### Define Environment Variables for Testing

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/09-examples.md

Set environment-specific variables in .env.testing to enable sandbox mode and local callbacks.

```env
# .env.testing
PAYMENT_CALLBACK_URL=http://localhost:8000/payment/callback
PAYMENT_AUTO_LOAD_GATEWAYS=true
PAYMENT_DEFAULT_CURRENCY=T
PAYMENT_ENABLE_LOGGING=true
PAYMENT_MODE=sandbox
```

--------------------------------

### verifyPayment(?string $driver = null)

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/01-api-reference.md

Verifies a payment callback from the payment gateway.

```APIDOC
## verifyPayment(?string $driver = null)

### Description
Verifies a payment callback from the payment gateway.

### Parameters
- **$driver** (string|null) - Optional - Payment gateway driver to verify with. Uses default if not specified

### Returns
- **mixed** - Receipt object containing payment verification details.

### Throws
- **\Illuminate\Database\Eloquent\ModelNotFoundException** - When driver not found or no default gateway is set.
```

--------------------------------

### Iran Kish Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Configuration structure for the Iran Kish gateway.

```php
[
    'merchantId' => 'irankish123',
    'sha1Key' => 'sha1_signing_key',
]
```

--------------------------------

### Modify package configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Override default settings by editing the published configuration file.

```php
return [
    'default_callback_url' => 'https://custom-domain.com/callback',
    'auto_load_gateways' => false,
    'driver_defaults' => [
        'zarinpal' => [
            'mode' => 'sandbox', // Override to sandbox by default
        ],
    ],
];
```

--------------------------------

### Service Container Resolution

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Shows how to resolve the PaymentManagerService using constructor injection or the app helper.

```php
public function __construct(PaymentManagerService $paymentManager)
{
    // Auto-resolved from container using type-hint
}

// Or manually in code:
$paymentManager = app(PaymentManagerService::class);
```

--------------------------------

### Configure PayPal Gateway

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/README.md

Configuration array for the PayPal payment driver.

```php
[
    'clientId' => 'your-client-id',
    'clientSecret' => 'your-client-secret',
    'callbackUrl' => 'https://yourdomain.com/payment/callback',
    'currency' => 'USD',
    'mode' => 'normal', // normal or sandbox
]
```

--------------------------------

### Zibal Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Configuration structure for the Zibal gateway.

```php
[
    'merchant' => 'zibal-merchant-id',
]
```

--------------------------------

### Retrieve Specific Gateway Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/06-payment-flow.md

Fetches a gateway by its driver name and retrieves its configuration, including database overrides.

```php
$zarinpal = $paymentManager->getGatewayByDriver('zarinpal');

if ($zarinpal && $zarinpal->is_active) {
    $config = $zarinpal->getConfigWithDefaults();
    // $config includes: driver defaults + database overrides
}
```

--------------------------------

### Access Shetabit Payment Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/03-configuration.md

Shows the configuration keys used by the package within Laravel's payment config.

```php
config('payment.default')  // Set from is_default gateway
config('payment.drivers.<driver_name>')  // Set from each registered gateway
```

--------------------------------

### Create and Process Payments

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/00-index.md

Use the PaymentManagerService to initiate and render payment processes.

```php
use AmidEsfahani\FilamentPaymentManager\Services\PaymentManagerService;

$paymentManager = app(PaymentManagerService::class);

// Create payment
$payment = $paymentManager->createPayment(10000);

// Process payment
$html = $payment->purchase($invoice)->pay()->render();
```

--------------------------------

### DriverService::getDriverDefaultConfig()

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Retrieves the default configuration array for a specific driver.

```APIDOC
## DriverService::getDriverDefaultConfig(string $driver)

### Description
Fetches the default configuration settings for the specified driver.

### Method
Static Method

### Parameters
- **driver** (string) - Required - The identifier of the driver (e.g., 'zarinpal')

### Returns
- **array** - The default configuration array for the driver
```

--------------------------------

### Callback & Redirect Settings Section Definition

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/05-filament-integration.md

Defines the section for handling callback URLs and redirect modes.

```php
Section::make('Callback & Redirect Settings')
├── TextInput: callback_url
│   ├── URL validation
│   ├── Placeholder from config
│   └── Helper text about defaults
├── Select: redirect_form_mode (reactive)
│   ├── Options: 'default', 'view', 'html'
│   ├── Default: 'default'
│   └── Full width
├── TextInput: redirect_form_view
│   ├── Conditional: visible when mode='view'
│   └── Placeholder: 'payments.redirect-form'
└── Textarea: redirect_form_html
    ├── Conditional: visible when mode='html'
    ├── 10 rows
    ├── Helper text about placeholders
    └── Full width
```

--------------------------------

### Extend PaymentGatewayResource

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/08-service-provider-reference.md

Create a custom resource class by extending the package's base resource.

```php
// app/Filament/Resources/CustomPaymentGatewayResource.php
use AmidEsfahaniilamentPaymentManagerilament
esources
esource;

class CustomPaymentGatewayResource extends PaymentGatewayResource
{
    // Add custom logic
}
```

--------------------------------

### Create Payment with Specific Driver

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/00-index.md

Creates a payment by explicitly specifying the driver name as the second argument.

```php
$payment = $paymentManager->createPayment(10000, 'zarinpal');
```

--------------------------------

### Stripe Gateway Configuration

Source: https://github.com/amidesfahani/filament-payment-manager/blob/v4/_autodocs/07-driver-reference.md

Configure the Stripe driver using a secret API key.

```php
[
    'secret' => 'sk_test_1234567890abcdef',
    'currency' => 'usd',
]
```
Tokens:
Raw