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

dmitry_fedyuk · February 15, 2016, 8:09am

Declaration

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


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

Definition

github.com

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


}


/**
 * Attempt to accept a payment that us under review
 *
 * @param InfoInterface $payment
 * @return false
 * @throws \Magento\Framework\Exception\LocalizedException
 * @api
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function acceptPayment(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#L484-L489


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


    return $this;
}

github.com

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


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

github.com

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


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

github.com

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


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

github.com

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


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

github.com

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


public function isInitializeNeeded()
{
    return $this->getVaultProvider()->isInitializeNeeded();
}

Usage

github.com

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


public function accept()
{
    $transactionId = $this->getLastTransId();


    /** @var \Magento\Payment\Model\Method\AbstractMethod $method */
    $method = $this->getMethodInstance();
    $method->setStore($this->getOrder()->getStoreId());
    if ($method->acceptPayment($this)) {
        $invoice = $this->_getInvoiceForTransactionId($transactionId);
        $message = $this->_appendTransactionToMessage(
            $transactionId,
            $this->prependMessage(__('Approved the payment online.'))
        );
        $this->updateBaseAmountPaidOnlineTotal($invoice);
        $this->setOrderStateProcessing($message);
    } else {
        $message = $this->_appendTransactionToMessage(
            $transactionId,
            $this->prependMessage(__('There is no need to approve this payment.'))
        );
        $this->setOrderStatePaymentReview($message, $transactionId);

github.com

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


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

dmitry_fedyuk · February 15, 2016, 8:17am