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

dmitry_fedyuk · February 15, 2016, 3:34am

Declaration

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


/**
 * Void payment abstract method
 *
 * @param InfoInterface $payment
 * @return $this
 * 
 */
public function void(\Magento\Payment\Model\InfoInterface $payment);

Definition

github.com

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


/**
 * Void payment abstract method
 *
 * @param \Magento\Framework\DataObject|InfoInterface $payment
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 * @api
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function void(\Magento\Payment\Model\InfoInterface $payment)
{
    if (!$this->canVoid()) {
        throw new \Magento\Framework\Exception\LocalizedException(__('The void action is not available.'));
    }
    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Authorizenet/Model/Directpost.php#L314-L321


/**
 * Void the payment through gateway
 *
 * @param \Magento\Framework\DataObject|\Magento\Payment\Model\InfoInterface $payment
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function void(\Magento\Payment\Model\InfoInterface $payment)

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Braintree/Model/PaymentMethod.php#L705-L713


/**
 * Voids transaction
 *
 * @param InfoInterface $payment
 * @throws LocalizedException
 * @return $this
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 */
public function void(InfoInterface $payment)

github.com

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


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


    return $this;
}

github.com

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


/**
 * Void payment
 *
 * @param \Magento\Framework\DataObject|\Magento\Payment\Model\InfoInterface|Payment $payment
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function void(\Magento\Payment\Model\InfoInterface $payment)
{
    $this->_pro->void($payment);
    return $this;
}

github.com

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


/**
 * Void payment
 *
 * @param \Magento\Framework\DataObject|\Magento\Payment\Model\InfoInterface|Payment $payment
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function void(\Magento\Payment\Model\InfoInterface $payment)

github.com

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


/**
 * Void payment
 *
 * @param InfoInterface|Payment|Object $payment
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 * @throws \Magento\Framework\Exception\State\InvalidTransitionException
 */
public function void(\Magento\Payment\Model\InfoInterface $payment)

github.com

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


/**
 * Void payment
 *
 * @param \Magento\Framework\DataObject|InfoInterface|Payment $payment
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function void(\Magento\Payment\Model\InfoInterface $payment)
{
    $this->_pro->void($payment);
    return $this;
}

github.com

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


public function void(\Magento\Payment\Model\InfoInterface $payment)
{
    throw new \DomainException("Not implemented");
}

Usage

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Authorizenet/Model/Authorizenet.php#L196-L205


/**
 * Cancel the payment through gateway
 *
 * @param  \Magento\Payment\Model\InfoInterface $payment
 * @return $this
 */
public function cancel(\Magento\Payment\Model\InfoInterface $payment)
{
    return $this->void($payment);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Braintree/Model/PaymentMethod.php#L811-L827


/**
 * Voids transaction on cancel action
 *
 * @param InfoInterface $payment
 * @return $this
 * @throws LocalizedException
 */
public function cancel(InfoInterface $payment)
{
    try {
        $this->void($payment);
    } catch (\Exception $e) {
        $this->_logger->critical($e);
        throw new LocalizedException(__('There was an error voiding the transaction: %1.', $e->getMessage()));
    }
    return $this;
}

github.com

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


/**
 * Cancel payment
 *
 * @param \Magento\Framework\DataObject|\Magento\Payment\Model\InfoInterface|Payment $payment
 * @return $this
 */
public function cancel(\Magento\Payment\Model\InfoInterface $payment)
{
    $this->void($payment);


    return $this;
}

github.com

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


/**
 * Cancel payment
 *
 * @param \Magento\Framework\DataObject|\Magento\Payment\Model\InfoInterface|Payment $payment
 * @return $this
 */
public function cancel(\Magento\Payment\Model\InfoInterface $payment)
{
    $this->void($payment);


    return $this;
}

github.com

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


/**
 * Attempt to void the authorization on cancelling
 *
 * @param InfoInterface|Object $payment
 * @return $this
 */
public function cancel(\Magento\Payment\Model\InfoInterface $payment)
{
    if (!$payment->getOrder()->getInvoiceCollection()->count()) {
        return $this->void($payment);
    }


    return false;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Payflow/Transparent.php#L172-L178


try {
    $this->responseValidator->validate($response, $this);
} catch (LocalizedException $exception) {
    $payment->setParentTransactionId($response->getData(self::PNREF));
    $this->void($payment);
    throw new LocalizedException(__('Error processing payment. Please try again later.'));
}

github.com

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


protected function _void($isOnline, $amount = null, $gatewayCallback = 'void')
{
    $order = $this->getOrder();
    $authTransaction = $this->getAuthorizationTransaction();
    $this->setTransactionId(
        $this->transactionManager->generateTransactionId($this, Transaction::TYPE_VOID, $authTransaction)
    );
    $this->setShouldCloseParentTransaction(true);


    // attempt to void
    if ($isOnline) {
        $method = $this->getMethodInstance();
        $method->setStore($order->getStoreId());
        $method->{$gatewayCallback}($this);
    }

github.com

magento/magento2/blob/6ce74b2/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;
}

Branch 1

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Controller/Adminhtml/Order/VoidPayment.php#L8-L24


class VoidPayment extends \Magento\Sales\Controller\Adminhtml\Order
{
/**
 * Attempt to void the order payment
 *
 * @return \Magento\Backend\Model\View\Result\Redirect
 */
public function execute()
{
    $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.'));

Branch 2

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Invoice.php#L379-L389


/**
 * Void invoice
 *
 * @return $this
 */
public function void()
{
    $this->getOrder()->getPayment()->void($this);
    $this->cancel();
    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Service/InvoiceService.php#L122-L125


public function setVoid($id)
{
    return (bool)$this->repository->get($id)->void();
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Controller/Adminhtml/Order/Invoice/Void.php#L25-L37


/** @var \Magento\Sales\Api\InvoiceManagementInterface $invoiceManagement */
$invoiceManagement = $this->_objectManager->get('Magento\Sales\Api\InvoiceManagementInterface');
$invoiceManagement->setVoid($invoice->getEntityId());


$invoice->getOrder()->setIsInProcess(true);
$this->_objectManager->create(
    'Magento\Framework\DB\Transaction'
)->addObject(
    $invoice
)->addObject(
    $invoice->getOrder()
)->save();
$this->messageManager->addSuccess(__('The invoice has been voided.'));

dmitry_fedyuk · February 15, 2016, 4:02am