SupportsAuthorizationsInterface.php in Commerce Core 8.2
File
modules/payment/src/Plugin/Commerce/PaymentGateway/SupportsAuthorizationsInterface.phpView source
<?php
namespace Drupal\commerce_payment\Plugin\Commerce\PaymentGateway;
use Drupal\commerce_payment\Entity\PaymentInterface;
use Drupal\commerce_price\Price;
/**
* Defines the interface for gateways which support authorizing payments.
*/
interface SupportsAuthorizationsInterface extends SupportsVoidsInterface {
/**
* Checks whether the given payment can be captured.
*
* @param \Drupal\commerce_payment\Entity\PaymentInterface $payment
* The payment to capture.
*
* @return bool
* TRUE if the payment can be captured, FALSE otherwise.
*/
public function canCapturePayment(PaymentInterface $payment);
/**
* Captures the given authorized payment.
*
* Only payments in the 'authorization' state can be captured.
*
* @param \Drupal\commerce_payment\Entity\PaymentInterface $payment
* The payment to capture.
* @param \Drupal\commerce_price\Price $amount
* The amount to capture. If NULL, defaults to the entire payment amount.
*
* @throws \Drupal\commerce_payment\Exception\PaymentGatewayException
* Thrown when the transaction fails for any reason.
*/
public function capturePayment(PaymentInterface $payment, Price $amount = NULL);
}
Interfaces
Name![]() |
Description |
---|---|
SupportsAuthorizationsInterface | Defines the interface for gateways which support authorizing payments. |