thephpleague/omnipay
Omnipay
Omnipay is a PHP payment gateway library and integration framework that abstracts multiple payment service providers into a single, consistent API. It provides a standardized interface for managing payment lifecycles, allowing applications to execute authorizations, captures, and refunds across various financial services without rewriting code for each provider.
The framework decouples application logic from provider-specific SDKs using an adapter pattern and data-transfer objects. This architecture ensures that raw gateway responses and HTTP requests are converted into predictable data shapes, while a configuration-based environment switch allows developers to toggle between sandbox and live API endpoints for testing transaction flows.
The library covers a broad range of payment processing capabilities, including credit card tokenization for recurring billing and the validation of card numbers using the Luhn algorithm. It handles the coordination of transaction lifecycles, including off-site redirect management and the processing of asynchronous gateway notifications via webhooks.
Additional functionality includes tools for customizing request payloads with arbitrary parameters and transmitting detailed line-item data to payment gateways.
Features
- Payment Gateways - Acts as a comprehensive library for integrating multiple payment gateways to execute authorizations, captures, and refunds.
- Payment Gateway Abstractions - Provides a unified interface that abstracts multiple payment gateways behind a single method contract.
- Payment Coordination Frameworks - Provides a coordination framework to manage the end-to-end payment lifecycle from authorization to final completion.
- Payment Detail Capture - Collects and validates credit card information and billing addresses using standardized data objects.
- Payment Gateway Integrations - Integrates multiple different payment service providers through a single standardized PHP interface.
- Notification Processing - Processes incoming asynchronous payloads from payment gateways to synchronize transaction states.
- Redirect Handlers - Detects when a gateway requires an off-site redirect and generates the necessary forwarding data for the user.
- Payment Integrations - Provides a comprehensive framework for managing payment lifecycles, gateway redirects, and transaction notifications.
- Payment Lifecycle Management - Handles the full transaction lifecycle, including payment authorization, capturing funds, and processing refunds.
- Payment Tokenization - Manages stored payment methods and tokens with gateways to enable recurring billing without re-entering card details.
- Payment Webhooks - Converts asynchronous HTTP notifications from payment providers into standardized objects to track transaction status.
- Sandbox Testing - Provides mechanisms to verify payment flows and transaction logic in sandbox environments without processing real funds.
- Payment Method Management - Implements systems for managing customer payment instruments, including the creation and deletion of stored card references.
- Payment Flow Simulation - Enables developers to toggle between sandbox and live environments to simulate and verify payment flows.
- API Environment Switchings - Supports toggling between sandbox and live API endpoints via configuration to isolate test transactions.
- Payment Tokenization Services - Provides a standardized way to use payment tokenization services to handle sensitive card data via external gateways.
- Adapter Patterns - Implements the adapter pattern to wrap provider-specific APIs into a consistent internal format.
- Data Transfer Object Mapping - Maps raw gateway responses and HTTP requests into structured data transfer objects for predictable data shapes.
- E-commerce and Payments - Provides a multi-gateway payment abstraction.
