interface ManualPaymentGatewayInterface in Commerce Core 8.2

Provides the base interface for manual payment gateways.

Manual payment gateways instruct the customer to pay the store in the real world. The gateway creates a payment entity to allow the merchant to track and record the money flow.

Examples: cash on delivery, pay in person, cheque, bank transfer, etc.

Hierarchy

• interface \Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\PaymentGatewayInterface; interface \Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\HasPaymentInstructionsInterface; interface \Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\SupportsVoidsInterface; interface \Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\SupportsRefundsInterface
  • interface \Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\ManualPaymentGatewayInterface

1 file declares its use of ManualPaymentGatewayInterface

PaymentProcess.php in modules/payment/src/Plugin/Commerce/CheckoutPane/PaymentProcess.php

File

modules/payment/src/Plugin/Commerce/PaymentGateway/ManualPaymentGatewayInterface.php, line 17

Namespace

Drupal\commerce_payment\Plugin\Commerce\PaymentGateway

interface ManualPaymentGatewayInterface extends PaymentGatewayInterface, HasPaymentInstructionsInterface, SupportsVoidsInterface, SupportsRefundsInterface {

  /**
   * Creates a payment.
   *
   * @param \Drupal\commerce_payment\Entity\PaymentInterface $payment
   *   The payment.
   * @param bool $received
   *   Whether the payment was already received.
   */
  public function createPayment(PaymentInterface $payment, $received = FALSE);

  /**
   * Receives the given payment.
   *
   * @param \Drupal\commerce_payment\Entity\PaymentInterface $payment
   *   The payment.
   * @param \Drupal\commerce_price\Price $amount
   *   The received amount. If NULL, defaults to the entire payment amount.
   */
  public function receivePayment(PaymentInterface $payment, Price $amount = NULL);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
DerivativeInspectionInterface::getBaseId	public	function	Gets the base_plugin_id of the plugin instance.	1
DerivativeInspectionInterface::getDerivativeId	public	function	Gets the derivative_id of the plugin instance.	1
HasPaymentInstructionsInterface::buildPaymentInstructions	public	function	Builds the payment instructions.	1
ManualPaymentGatewayInterface::createPayment	public	function	Creates a payment.	1
ManualPaymentGatewayInterface::receivePayment	public	function	Receives the given payment.	1
PaymentGatewayInterface::buildAvsResponseCodeLabel	public	function	Builds a label for the given AVS response code and card type.	1
PaymentGatewayInterface::buildPaymentOperations	public	function	Builds the available operations for the given payment.	1
PaymentGatewayInterface::collectsBillingInformation	public	function	Gets whether the payment gateway collects billing information.	1
PaymentGatewayInterface::getCreditCardTypes	public	function	Gets the credit card types handled by the gateway.	1
PaymentGatewayInterface::getDefaultPaymentMethodType	public	function	Gets the default payment method type.	1
PaymentGatewayInterface::getDisplayLabel	public	function	Gets the payment gateway display label.	1
PaymentGatewayInterface::getJsLibrary	public	function	Gets the JS library ID.	1
PaymentGatewayInterface::getLabel	public	function	Gets the payment gateway label.	1
PaymentGatewayInterface::getMode	public	function	Gets the mode in which the payment gateway is operating.	1
PaymentGatewayInterface::getPaymentMethodTypes	public	function	Gets the payment method types handled by the payment gateway.	1
PaymentGatewayInterface::getPaymentType	public	function	Gets the payment type used by the payment gateway.	1
PaymentGatewayInterface::getSupportedModes	public	function	Gets the supported modes.	1
PaymentGatewayInterface::toMinorUnits Deprecated	public	function	Converts the given amount to its minor units.	1
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
PluginWithFormsInterface::getFormClass	public	function	Gets the form class for the given operation.
PluginWithFormsInterface::hasFormClass	public	function	Gets whether the plugin has a form class for the given operation.
SupportsRefundsInterface::canRefundPayment	public	function	Checks whether the given payment can be refunded.
SupportsRefundsInterface::refundPayment	public	function	Refunds the given payment.	2
SupportsVoidsInterface::canVoidPayment	public	function	Checks whether the given payment can be voided.
SupportsVoidsInterface::voidPayment	public	function	Voids the given payment.	2