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

dmitry_fedyuk · February 15, 2016, 8:24am

Declaration

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


/**
 * Attempt to deny a payment that us under review
 *
 * @param InfoInterface $payment
 * @return false
 * @throws \Magento\Framework\Exception\LocalizedException
 * 
 */
public function denyPayment(InfoInterface $payment);

Definition

github.com

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


/**
 * Attempt to deny a payment that us under review
 *
 * @param InfoInterface $payment
 * @return false
 * @throws \Magento\Framework\Exception\LocalizedException
 * @api
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function denyPayment(InfoInterface $payment)
{
    if (!$this->canReviewPayment()) {
        throw new \Magento\Framework\Exception\LocalizedException(__('The payment review action is unavailable.'));
    }
    return false;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/Adapter.php#L494-L499


public function denyPayment(InfoInterface $payment)
{
    $this->executeCommand('deny_payment', ['payment' => $payment]);


    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Direct.php#L384-L394


/**
 * Attempt to deny a pending payment
 *
 * @param \Magento\Payment\Model\Info|PaymentInterface $payment
 * @return bool
 */
public function denyPayment(\Magento\Payment\Model\InfoInterface $payment)
{
    parent::denyPayment($payment);
    return $this->_pro->reviewPayment($payment, \Magento\Paypal\Model\Pro::PAYMENT_REVIEW_DENY);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Express.php#L616-L626


/**
 * Attempt to deny a pending payment
 *
 * @param \Magento\Payment\Model\InfoInterface|Payment $payment
 * @return bool
 */
public function denyPayment(\Magento\Payment\Model\InfoInterface $payment)
{
    parent::denyPayment($payment);
    return $this->_pro->reviewPayment($payment, \Magento\Paypal\Model\Pro::PAYMENT_REVIEW_DENY);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Payflowpro.php#L666-L675


/**
 * Attempt to deny a pending payment
 *
 * @param InfoInterface $payment
 * @return bool
 */
public function denyPayment(InfoInterface $payment)
{
    return $this->reviewPayment($payment, self::UPDATEACTION_DECLINED_BY_MERCHANT);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Method/Agreement.php#L366-L376


/**
 * Attempt to deny a pending payment
 *
 * @param InfoInterface|Payment $payment
 * @return bool
 */
public function denyPayment(InfoInterface $payment)
{
    parent::denyPayment($payment);
    return $this->_pro->reviewPayment($payment, \Magento\Paypal\Model\Pro::PAYMENT_REVIEW_DENY);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Vault/Model/Method/Vault.php#L535-L538


public function denyPayment(InfoInterface $payment)
{
    throw new \DomainException("Not implemented");
}

Usage

github.com

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


/**
 * Accept order with payment method instance
 *
 * @param bool $isOnline
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function deny($isOnline = true)
{
    $transactionId = $isOnline ? $this->getLastTransId() : $this->getTransactionId();


    if ($isOnline) {
        /** @var \Magento\Payment\Model\Method\AbstractMethod $method */
        $method = $this->getMethodInstance();
        $method->setStore($this->getOrder()->getStoreId());


        $result = $method->denyPayment($this);
    } else {
        $result = (bool)$this->getNotificationResult();
    }

github.com

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


    if ($result) {
        $invoice = $this->_getInvoiceForTransactionId($transactionId);
        $message = $this->_appendTransactionToMessage(
            $transactionId,
            $this->prependMessage(__('Denied the payment online'))
        );
        $this->cancelInvoiceAndRegisterCancellation($invoice, $message);
    } else {
        $txt = $isOnline ?
            'There is no need to deny this payment.' : 'Registered notification about denied payment.';
        $message = $this->_appendTransactionToMessage(
            $transactionId,
            $this->prependMessage(__($txt))
        );
        $this->setOrderStatePaymentReview($message, $transactionId);
    }
    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Controller/Adminhtml/Order/ReviewPayment.php#L31-L34


case 'deny':
    $order->getPayment()->deny();
    $message = __('The payment has been denied.');
    break;

dmitry_fedyuk · February 15, 2016, 8:31am