Log in

Payment Module

Api\Data\PaymentAdditionalInfoInterface

Interface

This interface defines a contract for storing additional payment information as key-value pairs in Magento 2. Developers use this to pass extra paymen...

Api\Data\PaymentMethodInterface

Interface

This interface defines the contract for payment method data objects in Magento 2's API layer. Developers use this interface when retrieving payment me...

Api\PaymentMethodListInterface

Interface

This interface defines the contract for retrieving payment methods in Magento 2. Developers use implementations of this interface to fetch all payment...

Api\PaymentVerificationInterface

Interface

This interface defines a contract for payment methods to provide verification codes like AVS (Address Verification System) or CVV codes from payment p...

Cart

Model

This class provides a unified way to collect and manage cart item information from sales models (quotes, orders, invoices, credit memos) for payment p...

Cart\SalesModel\Order

Model

This class wraps a Magento Sales Order model to provide a standardized interface for payment cart operations. Developers use this adapter when integra...

Cart\SalesModel\Quote

Model

This class wraps a Magento Quote model to provide a standardized interface for payment-related operations. Developers use it when integrating payment...

CcConfig

Model

This class provides configuration data and utilities for credit card payment methods in Magento 2. Developers use it to retrieve credit card types, ex...

CcConfigProvider

Model

This class provides configuration data for credit card payment forms in the Magento checkout process. It retrieves and prepares credit card type icons...

CcGenericConfigProvider

Model

This class provides configuration data for credit card payment methods during checkout in Magento 2. It generates frontend configuration including ava...

Checks\CanUseCheckout

Model

This class checks whether a payment method can be used during the storefront checkout process. Developers use this specification to validate payment m...

Checks\CanUseForCountry

Model

This class validates whether a payment method can be used in a specific country during the checkout process. It checks the quote's billing/shipping co...

Checks\CanUseForCountry\CountryProvider

Model

This class determines which country to use when validating payment method availability during checkout. It retrieves the country from the billing addr...

Checks\CanUseForCurrency

Model

This class validates whether a payment method can be used with a specific currency in a quote. Developers use this during checkout to filter out payme...

Checks\CanUseInternal

Model

This class checks whether a payment method can be used in the Magento admin area when creating orders. Developers use this as part of the payment meth...

Checks\Composite

Model

This class acts as a composite specification pattern implementation that validates whether a payment method can be used with a quote by running multip...

Checks\TotalMinMax

Model

This class validates whether a payment method can be used based on the order's total amount. It checks if the quote's grand total falls within the min...

Checks\ZeroTotal

Model

This class validates whether a payment method can be used when a quote has a zero or near-zero total. It prevents regular payment methods from being u...

Config

Model

This class provides configuration and utility methods for payment methods in Magento 2. Developers use it to retrieve active payment methods, get cred...

Config\Converter

Model

This converter class transforms payment configuration XML files into PHP arrays. Developers use this when Magento loads payment configuration during s...

Config\Reader

Model

This class reads and merges payment configuration XML files from various modules in Magento 2. It extends the framework's filesystem configuration rea...

Config\SchemaLocator

Model

This class locates and provides paths to XSD schema files used for validating payment configuration XML files in Magento 2. Developers use it to ensur...

Config\Source\Allmethods

Model

This class provides a source model for retrieving all available payment methods in Magento 2. Developers use it in system configuration XML files to p...

Config\Source\Allspecificcountries

Model

This class provides configuration options for payment methods to specify whether they should be available for all allowed countries or only specific c...

Config\Source\Cctype

Model

This class provides a source model for credit card type configuration options in Magento's admin panel. Developers use it when creating system configu...

Data

Helper

This helper class provides utility methods for working with payment methods in Magento 2. Developers use it to retrieve payment method instances, get...

IframeConfigProvider

Model

This class provides frontend configuration for payment methods that use iframe integration, such as hosted payment forms. Developers use this when imp...

Info

Model

This class stores and manages payment information for orders in Magento 2. Developers use it to access payment method details, encrypt/decrypt sensiti...

MethodList

Model

This service class retrieves and filters all available payment methods for a given shopping cart/quote. Developers use it when they need to display pa...

Method\AbstractMethod

Model

This abstract class serves as the base implementation for all payment methods in Magento 2. Developers extend this class when creating custom payment...

Method\Adapter

Model

This class serves as a universal adapter for payment methods in Magento 2, providing a standardized interface to execute payment operations like autho...

Method\Cc

Model

This is the base credit card payment method class that provides core functionality for validating credit card information including card numbers, CVV...

Method\Free

Model

This class implements the 'Free' payment method in Magento 2, which is used when an order total is zero (e.g., using discount codes, store credit, or...

Method\Logger

Model

This class provides debug logging functionality specifically for payment-related data in Magento 2. It allows developers to log payment requests, resp...

Method\Specification\AbstractSpecification

Model

This abstract class serves as a base for implementing payment method specifications in Magento 2. Developers extend this class to create custom rules...

Method\Specification\Composite

Model

This class implements the Composite design pattern to evaluate multiple payment method specifications together. Developers use it to combine multiple...

Method\Substitution

Model

This class serves as a placeholder payment method for orders that used payment methods which no longer exist in the system. It allows Magento to displ...

Model\Cart\SalesModel\Factory

Factory

This factory creates wrapper objects that adapt Magento sales models (Quote or Order) into a standardized payment cart interface. Developers use this...

Model\Cart\SalesModel\SalesModelInterface

Interface

This interface defines a standard contract for accessing sales-related data (like quotes or orders) in payment processing contexts. Developers impleme...

Model\Checks\SpecificationFactory

Factory

This factory class creates composite payment method specifications by mapping specification identifiers to their actual specification objects. Develop...

Model\Checks\SpecificationInterface

Interface

This interface defines a contract for payment method specification checks in Magento 2. Developers implement this interface to create custom validator...

Model\InfoInterface

Interface

This interface defines the contract for payment information objects in Magento 2. Developers use it to store, retrieve, and manage sensitive payment d...

Model\MethodInterface

Interface

This interface defines the contract for all payment methods in Magento 2. Developers implement this interface when creating custom payment methods, de...

Model\Method\ConfigInterface

Interface

This deprecated interface formerly defined the contract for payment method configuration in Magento 2. It extends the Payment Gateway ConfigInterface...

Model\Method\Factory

Factory

This factory class is responsible for creating instances of payment method models in Magento 2. Developers use this class when they need to dynamicall...

Model\Method\InstanceFactory

Factory

This factory class creates and configures payment method instances in Magento 2. It retrieves a payment method by its code using the Payment Helper an...

Model\Method\Online\GatewayInterface

Interface

This interface defines the contract for online payment gateway integrations in Magento 2. Developers implement this interface when creating custom pay...

Model\Method\SpecificationInterface

Interface

This interface defines a specification pattern for validating payment methods in Magento 2. Developers implement this interface to create custom rules...

Model\Method\Specification\Factory

Factory

This factory class creates specification objects that define rules or criteria for payment methods. Developers use this to instantiate payment method...

Model\Method\TransparentInterface

Interface

This interface defines the contract for payment methods that support transparent redirect functionality, where customers are redirected to a payment g...

Model\SaleOperationInterface

Interface

This interface defines the contract for payment methods that support the 'sale' operation, which combines authorization and capture in a single transa...

Paygate\Result

Model

This class serves as a data container for payment gateway results in Magento 2. Developers use it to store and retrieve response data from payment gat...

PaymentAdditionalInfo

Model

This class serves as a data container for storing additional payment information as key-value pairs. Developers use this class when they need to attac...

PaymentMethod

Model

This class represents a payment method entity in Magento 2, providing a data transfer object (DTO) for payment method information. Developers use this...

PaymentMethodList

Model

This class retrieves and manages payment methods available in a Magento store. Developers use it to get a complete list of all payment methods or filt...

ResourceModel\Grid\GroupList

Model

This class provides a list of payment method groups as an option array, typically used for dropdown filters in admin grids. Developers use this when t...

ResourceModel\Grid\TypeList

Model

This class provides a list of available payment method types as an option array for use in Magento's admin grid filters and form selects. Developers u...

Source\Cctype

Model

This source model provides a list of credit card types (Visa, MasterCard, etc.) that can be used in Magento's payment configuration. Developers use th...

Source\Invoice

Model

This source model provides configuration options for automatic invoice creation in payment methods. Developers use this class to populate dropdown fie...