Contracts (API Reference)

All interfaces in the Frolax\Payment\Contracts namespace.

GatewayDriverContract

Core interface every gateway driver must implement.

namespace Frolax\Payment\Contracts;

interface GatewayDriverContract
{
    public function name(): string;
    public function create(CanonicalPayload $payload, CredentialsDTO $credentials): GatewayResult;
    public function verify(Request $request, CredentialsDTO $credentials): GatewayResult;
    public function setCredentials(CredentialsDTO $credentials): static;
    public function capabilities(): array;
}

---

SupportsHostedRedirect

interface SupportsHostedRedirect
{
    public function getRedirectUrl(GatewayResult $result): ?string;
}

---

SupportsWebhookVerification

interface SupportsWebhookVerification
{
    public function verifyWebhookSignature(Request $request, CredentialsDTO $credentials): bool;
    public function parseWebhookEventType(Request $request): ?string;
    public function parseWebhookGatewayReference(Request $request): ?string;
}

---

SupportsRefund

interface SupportsRefund
{
    public function refund(CanonicalRefundPayload $payload, CredentialsDTO $credentials): GatewayResult;
}

---

SupportsStatusQuery

interface SupportsStatusQuery
{
    public function status(CanonicalStatusPayload $payload, CredentialsDTO $credentials): GatewayResult;
}

---

SupportsTokenization Future

interface SupportsTokenization
{
    public function tokenize(CanonicalPayload $payload, CredentialsDTO $credentials): GatewayResult;
    public function chargeToken(string $token, CanonicalPayload $payload, CredentialsDTO $credentials): GatewayResult;
}

---

SupportsInstallments Future

interface SupportsInstallments
{
    public function installmentPlans(CanonicalPayload $payload, CredentialsDTO $credentials): array;
}

---

CredentialsRepositoryContract

interface CredentialsRepositoryContract
{
    public function get(string $gateway, string $profile = 'test', array $context = []): ?CredentialsDTO;
    public function has(string $gateway, string $profile = 'test', array $context = []): bool;
}

Implementations:

• EnvCredentialsRepository — Reads from config
• DatabaseCredentialsRepository — Reads from DB with tenant/time/priority
• CompositeCredentialsRepository — DB first, fallback to ENV

---

PaymentLoggerContract

interface PaymentLoggerContract
{
    public function log(string $level, string $category, string $message, array $context = []): void;
    public function info(string $category, string $message, array $context = []): void;
    public function warning(string $category, string $message, array $context = []): void;
    public function error(string $category, string $message, array $context = []): void;
    public function debug(string $category, string $message, array $context = []): void;
}

---

GatewayAddonContract

Contract for auto-discovered gateway addon packages.

interface GatewayAddonContract
{
    public function gatewayKey(): string;
    public function displayName(): string;
    public function driverClass(): string|callable;
    public function capabilities(): array;
    public function credentialSchema(): array;
    public function defaultConfig(): array;
}