How is a payment method's canRefund() used?

dmitry_fedyuk · February 10, 2016, 2:07am

Declaration

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/MethodInterface.php#L95-L101


/**
 * Check refund availability
 *
 * @return bool
 * 
 */
public function canRefund();

Definition

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L341-L350


/**
 * Check refund availability
 *
 * @return bool
 * @api
 */
public function canRefund()
{
    return $this->_canRefund;
}

Usages

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L640-L656


/**
 * Refund specified amount for payment
 *
 * @param \Magento\Framework\DataObject|InfoInterface $payment
 * @param float $amount
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 * @api
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function refund(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    if (!$this->canRefund()) {
        throw new \Magento\Framework\Exception\LocalizedException(__('The refund action is not available.'));
    }
    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment.php#L283-L289


/**
 * @return bool
 */
public function canRefund()
{
    return $this->getMethodInstance()->canRefund();
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment.php#L629-L633


// call refund from gateway if required
$isOnline = false;
$gateway = $this->getMethodInstance();
$invoice = null;
if ($gateway->canRefund() && $creditmemo->getDoTransaction()) {

dmitry_fedyuk · February 10, 2016, 2:10am