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

dmitry_fedyuk · February 15, 2016, 2:54am

Declaration

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


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

Definition

github.com

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


/**
 * Cancel payment abstract method
 *
 * @param \Magento\Framework\DataObject|InfoInterface $payment
 * @return $this
 * @api
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function cancel(\Magento\Payment\Model\InfoInterface $payment)
{
    return $this;
}

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/Payment/Model/Method/Adapter.php#L464-L469


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


    return $this;
}

github.com

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


/**
 * 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/Billing/Agreement.php#L185-L195


/**
 * Cancel billing agreement
 *
 * @return $this
 */
public function cancel()
{
    $this->setStatus(self::STATUS_CANCELED);
    $this->getPaymentMethodInstance()->updateBillingAgreementStatus($this);
    return $this->save();
}

github.com

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


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

github.com

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


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

Usage

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#L808-L832


/**
 * Order cancellation hook for payment method instance
 * Adds void transaction if needed
 *
 * @return $this
 */
public function cancel()
{
    $isOnline = true;
    if (!$this->canVoid()) {
        $isOnline = false;
    }


    if (!$this->hasMessage()) {
        $this->setMessage($isOnline ? __('Canceled order online') : __('Canceled order offline'));
    }


    if ($isOnline) {
        $this->_void($isOnline, null, 'cancel');
    }


    $this->_eventManager->dispatch('sales_order_payment_cancel', ['payment' => $this]);


    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order.php#L1100-L1115


/**
 * Cancel order
 *
 * @return $this
 */
public function cancel()
{
    if ($this->canCancel()) {
        $this->getPayment()->cancel();
        $this->registerCancellation();


        $this->_eventManager->dispatch('order_cancel_after', ['order' => $this]);
    }


    return $this;
}

dmitry_fedyuk · February 15, 2016, 3:09am