How is a payment authorization voiding implemented?

dmitry_fedyuk · March 15, 2016, 10:10am

Interface

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Block/Adminhtml/Order/View.php#L149-L159


// invoice action intentionally
if ($this->_isAllowedAction('Magento_Sales::invoice') && $order->canVoidPayment()) {
    $message = __('Are you sure you want to void the payment?');
    $this->addButton(
        'void_payment',
        [
            'label' => __('Void'),
            'onclick' => "confirmSetLocation('{$message}', '{$this->getVoidPaymentUrl()}')"
        ]
    );
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order.php#L549-L556


/**
 * Getter whether the payment can be voided
 * @return bool
 */
public function canVoidPayment()
{
    return $this->_canVoidOrder() ? $this->getPayment()->canVoid() : false;
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order.php#L558-L566


/**
 * Check whether order could be canceled by states and flags
 *
 * @return bool
 */
protected function _canVoidOrder()
{
    return !($this->isCanceled() || $this->canUnhold() || $this->isPaymentReview());
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Payment.php#L540-L555


/**
 * Check order payment void availability
 *
 * @return bool
 */
public function canVoid()
{
    if (null === $this->_canVoidLookup) {
        $this->_canVoidLookup = (bool)$this->getMethodInstance()->canVoid();
        if ($this->_canVoidLookup) {
            $authTransaction = $this->getAuthorizationTransaction();
            $this->_canVoidLookup = (bool)$authTransaction && !(int)$authTransaction->getIsClosed();
        }
    }
    return $this->_canVoidLookup;
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Payment.php#L1254-L1265


/**
 * Lookup an authorization transaction using parent transaction id, if set
 * @return Transaction|false
 */
public function getAuthorizationTransaction()
{
    return $this->transactionManager->getAuthorizationTransaction(
        $this->getParentTransactionId(),
        $this->getId(),
        $this->getOrder()->getId()
    );
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Payment/Transaction/ManagerInterface.php#L17-L25


/**
 * Lookup an authorization transaction using parent transaction id, if set
 *
 * @param string $parentTransactionId
 * @param int $paymentId
 * @param int $orderId
 * @return false|Transaction
 */
public function getAuthorizationTransaction($parentTransactionId, $paymentId, $orderId);

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Payment/Transaction/Manager.php#L28-L47


/**
 * {@inheritdoc}
 */
public function getAuthorizationTransaction($parentTransactionId, $paymentId, $orderId)
{
    $transaction = false;
    if ($parentTransactionId) {
        $transaction = $this->transactionRepository->getByTransactionId(
            $parentTransactionId,
            $paymentId,
            $orderId
        );
    }


    return $transaction ?: $this->transactionRepository->getByTransactionType(
        Transaction::TYPE_AUTH,
        $paymentId,
        $orderId
    );
}

Controller

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Controller/Adminhtml/Order/VoidPayment.php#L10-L15


/**
 * Attempt to void the order payment
 *
 * @return \Magento\Backend\Model\View\Result\Redirect
 */
public function execute()

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Controller/Adminhtml/Order/VoidPayment.php#L16-L36


{
    $order = $this->_initOrder();
    $resultRedirect = $this->resultRedirectFactory->create();
    if ($order) {
        try {
            // workaround for backwards compatibility
            $order->getPayment()->void(new \Magento\Framework\DataObject());
            $order->save();
            $this->messageManager->addSuccess(__('The payment has been voided.'));
        } catch (\Magento\Framework\Exception\LocalizedException $e) {
            $this->messageManager->addError($e->getMessage());
        } catch (\Exception $e) {
            $this->messageManager->addError(__('We can\'t void the payment right now.'));
            $this->_objectManager->get('Psr\Log\LoggerInterface')->critical($e);
        }
        $resultRedirect->setPath('sales/*/view', ['order_id' => $order->getId()]);
        return $resultRedirect;
    }
    $resultRedirect->setPath('sales/*/');
    return $resultRedirect;
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Payment.php#L557-L569


/**
 * Void payment online
 *
 * @param \Magento\Framework\DataObject $document
 * @return $this
 * @see self::_void()
 */
public function void(\Magento\Framework\DataObject $document)
{
    $this->_void(true);
    $this->_eventManager->dispatch('sales_order_payment_void', ['payment' => $this, 'invoice' => $document]);
    return $this;
}

Details How does \Magento\Sales\Model\Order\Payment::_void() work?

dmitry_fedyuk · March 15, 2016, 10:23am