GatewayPack Integration Guide

This document provides details about adding and managing payment gateways in the GatewayPack module. It also describes available methods in the system and their usage.

---

Overview

GatewayPack is designed for seamless integration and management of payment gateways. The system provides a trait ( HelperGateway) for shared functionality and a structured way to implement new gateways.

---

How to Add a New Gateway

1. Create a Gateway Class

   • All gateways must implement the PaymentGatewayInterface and use the HelperGateway trait for shared functionality.

2. Register the Gateway

   • Add the gateway class to the GatewayPack registry in the Modules\\GatewayPack\\Entities\\GatewayPack class.

3. Define Drivers and Configuration

   • Implement methods like getConfigMerge() and drivers() to define specific behaviors for your gateway.

---

Available Methods in HelperGateway Trait

1. getGatewayByEndpoint()

• Retrieves the Gateway model instance based on its endpoint.
• Return Type:Gateway
• Usage:

  $gateway = self::getGatewayByEndpoint();

2. errorRedirect(string $message)

• Redirects the user to the dashboard with an error message.
• Usage:

  returnself::errorRedirect('Payment failed');

3. getReturnUrl()

• Generates the return URL for the payment gateway.
• Return Type:string
• Usage:

  $url = self::getReturnUrl();

4. getCancelUrl(Payment $payment)

• Generates the cancel URL for the payment gateway.
• Return Type:string
• Usage:

  $url = self::getCancelUrl($payment);

5. getSucceedUrl(Payment $payment)

• Generates the success URL for the payment gateway.
• Return Type:string
• Usage:

  $url = self::getSucceedUrl($payment);

6. sendHttpRequest(string $method, string $url, array $data = [], ?string $token = null)

• Sends an HTTP request (GET or POST) to the specified URL.
• Parameters:
  • $method: HTTP method (GET or POST).
  • $url: URL to send the request.
  • $data: Request payload.
  • $token: Optional authorization token.
• Return Type:HttpResponse
• Usage:

  $response = self::sendHttpRequest('POST', $url, $data, $token);

7. log(string $message, string $level = 'info')

• Logs a message with the specified level.
• Parameters:
  • $message: Message to log.
  • $level: Log level (info, warning, error).
• Usage:

  self::log('Payment failed', 'error');

---

Examples

Adding a New Gateway

Here is a step-by-step example for adding a new payment gateway:

1. Create a New Gateway Class

   • Use the HelperGateway trait for common functionality and implement PaymentGatewayInterface.

   namespaceModules\GatewayPack\Gateways\Once;
   useApp\Models\Gateways\Gateway;
   useApp\Models\Gateways\PaymentGatewayInterface;
   useApp\Models\Payment;
   useIlluminate\Http\Request;
   useModules\GatewayPack\Traits\HelperGateway;
   class ExampleGateway implements PaymentGatewayInterface
   {
   use HelperGateway;
   publicstaticfunctionendpoint(): string
   {
   return'example-gateway';
   }
   publicstaticfunctiongetConfigMerge(): array
   {
   return [
   'api_key' => '',
   'test_mode' => true,
   ];
   }
   publicstaticfunctiondrivers(): array
   {
   return [
   'ExampleGateway' => [
   'driver' => 'ExampleGateway',
   'type' => 'once',
   'class' => self::class,
   'endpoint' => self::endpoint(),
   'refund_support' => false,
   ],
   ];
   }
   publicstaticfunctionprocessGateway(Gateway$gateway, Payment$payment)
   {
   // Implementation for payment processing
   }
   publicstaticfunctionreturnGateway(Request$request)
   {
   // Implementation for handling gateway return
   }
   }

2. Register the Gateway

   • Add the new gateway to the GatewayPack registry.

   namespaceModules\GatewayPack\Entities;
   useModules\GatewayPack\Gateways\Once\ExampleGateway;
   class GatewayPack
   {
   protectedstaticarray$gateways = [
   ExampleGateway::class,
   ];
   publicstaticfunctiondrivers(): array
   {
   $drivers = [];
   foreach (self::$gatewaysas$class) {
   if (method_exists($class, 'drivers')) {
   $drivers = array_merge($drivers, $class::drivers());
   }
   }
   return$drivers;
   }
   }

---

Happy coding! 😊