interface PayflowLinkInterface in Commerce PayPal 8

Provides the interface for the PayflowLink payment gateway.

Hierarchy

• interface \Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\OffsitePaymentGatewayInterface; interface \Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\SupportsAuthorizationsInterface; interface \Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\SupportsRefundsInterface
  • interface \Drupal\commerce_paypal\Plugin\Commerce\PaymentGateway\PayflowLinkInterface

File

src/Plugin/Commerce/PaymentGateway/PayflowLinkInterface.php, line 15

Namespace

Drupal\commerce_paypal\Plugin\Commerce\PaymentGateway

interface PayflowLinkInterface extends OffsitePaymentGatewayInterface, SupportsAuthorizationsInterface, SupportsRefundsInterface {

  /**
   * Requests a secure token from Payflow for use in follow-up API requests.
   *
   * @param \Drupal\commerce_order\Entity\OrderInterface $order
   *   The order whose details should be submitted in the secure token request.
   *
   * @return string|null
   *   The secure Token if successfully retrieved, NULL on failure.
   *
   * @throws \Drupal\Core\TypedData\Exception\MissingDataException
   */
  public function createSecureToken(OrderInterface $order);

  /**
   * Gets the redirect url.
   *
   * @param \Drupal\commerce_order\Entity\OrderInterface|null $order
   *   (Optional) The order.
   *
   * @return string
   *   The URL according selected 'mode' and 'redirect_method' settings.
   */
  public function getRedirectUrl(OrderInterface $order = NULL);

  /**
   * Creates a reference payment.
   *
   * @param \Drupal\commerce_payment\Entity\PaymentInterface $payment
   *   The payment to reference.
   * @param \Drupal\commerce_price\Price|null $amount
   *   The amount to use in reference payment.
   *
   * @throws \Drupal\commerce_payment\Exception\PaymentGatewayException
   *   Thrown when the transaction fails for any reason.
   */
  public function referencePayment(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
OffsitePaymentGatewayInterface::getNotifyUrl	public	function	Gets the URL to the "notify" page.	1
OffsitePaymentGatewayInterface::onCancel	public	function	Processes the "cancel" request.	1
OffsitePaymentGatewayInterface::onReturn	public	function	Processes the "return" request.	1
PayflowLinkInterface::createSecureToken	public	function	Requests a secure token from Payflow for use in follow-up API requests.	1
PayflowLinkInterface::getRedirectUrl	public	function	Gets the redirect url.	1
PayflowLinkInterface::referencePayment	public	function	Creates a reference 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.
SupportsAuthorizationsInterface::canCapturePayment	public	function	Checks whether the given payment can be captured.
SupportsAuthorizationsInterface::capturePayment	public	function	Captures the given authorized payment.	1
SupportsNotificationsInterface::onNotify	public	function	Processes the notification request.	1
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