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

dmitry_fedyuk · February 14, 2016, 11:58pm

Declaration

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


/**
 * Refund specified amount for payment
 *
 * @param InfoInterface $payment
 * @param float $amount
 * @return $this
 * 
 */
public function refund(\Magento\Payment\Model\InfoInterface $payment, $amount);

Definition

github.com

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


/**
 * Refund specified amount for payment
 *
 * @param \Magento\Framework\DataObject|InfoInterface $payment
 * @param float $amount
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 * @api
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function refund(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    if (!$this->canRefund()) {
        throw new \Magento\Framework\Exception\LocalizedException(__('The refund action is not available.'));
    }
    return $this;
}

github.com

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


/**
 * Refund the amount
 * Need to decode last 4 digits for request.
 *
 * @param \Magento\Framework\DataObject|\Magento\Payment\Model\InfoInterface $payment
 * @param float $amount
 * @return $this
 * @throws \Exception
 */
public function refund(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    $last4 = $payment->getCcLast4();
    $payment->setCcLast4($payment->decrypt($last4));
    try {
        $this->processRefund($payment, $amount);
    } catch (\Exception $e) {
        $payment->setCcLast4($last4);
        throw $e;
    }
    $payment->setCcLast4($last4);
    return $this;

github.com

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


/**
 * Refunds specified amount
 *
 * @param InfoInterface $payment
 * @param float $amount
 * @return $this
 * @throws LocalizedException
 */
public function refund(InfoInterface $payment, $amount)

github.com

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


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


    return $this;
}

github.com

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


/**
 * Refund capture
 *
 * @param \Magento\Framework\DataObject|\Magento\Payment\Model\InfoInterface|Payment $payment
 * @param float $amount
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function refund(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    $this->_pro->refund($payment, $amount);
    return $this;
}

github.com

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


/**
 * Refund capture
 *
 * @param \Magento\Framework\DataObject|\Magento\Payment\Model\InfoInterface|Payment $payment
 * @param float $amount
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function refund(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    $this->_pro->refund($payment, $amount);
    return $this;
}

github.com

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


/**
 * Refund capture
 *
 * @param InfoInterface|Payment|Object $payment
 * @param float $amount
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 * @throws \Magento\Framework\Exception\State\InvalidTransitionException
 */
public function refund(\Magento\Payment\Model\InfoInterface $payment, $amount)

github.com

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


/**
 * Refund capture
 *
 * @param \Magento\Framework\DataObject|InfoInterface|Payment $payment
 * @param float $amount
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function refund(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    $this->_pro->refund($payment, $amount);
    return $this;
}

github.com

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


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

Usage

github.com

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


// TODO: implement multiple refunds per capture
try {
    $gateway->setStore(
        $this->getOrder()->getStoreId()
    );
    $this->setRefundTransactionId($invoice->getTransactionId());
    $gateway->refund($this, $baseAmountToRefund);


    $creditmemo->setTransactionId($this->getLastTransId());
} catch (\Magento\Framework\Exception\LocalizedException $e) {

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/ResourceModel/Order/Creditmemo/Relation/Refund.php#L150-L161


/**
 * Prepare payment data for refund
 *
 * @param \Magento\Sales\Model\Order\Creditmemo $creditmemo
 * @return void
 */
protected function preparePayment(\Magento\Sales\Model\Order\Creditmemo $creditmemo)
{
    if (!$creditmemo->getPaymentRefundDisallowed()) {
        $creditmemo->getOrder()->getPayment()->refund($creditmemo);
    }
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/ResourceModel/Order/Creditmemo/Relation/Refund.php#L46-L65


/**
 * Process relations for CreditMemo
 *
 * @param \Magento\Framework\Model\AbstractModel $object
 * @throws \Exception
 * @return void
 */
public function processRelation(\Magento\Framework\Model\AbstractModel $object)
{
    /** @var \Magento\Sales\Model\Order\Creditmemo $object */
    if ($object->getState() == \Magento\Sales\Model\Order\Creditmemo::STATE_REFUNDED) {
        $this->prepareOrder($object);
        if ($object->getInvoice()) {
            $this->prepareInvoice($object);
            $this->invoiceRepository->save($object->getInvoice());
        }
        $this->preparePayment($object);
        $this->orderRepository->save($object->getOrder());
    }
}

github.com

magento/magento2/blob/6ce74b2/lib/internal/Magento/Framework/Model/ResourceModel/Db/VersionControl/RelationComposite.php#L38-L56


/**
 * Process model's relations saves
 *
 * @param AbstractModel $object
 * @return void
 */
public function processRelations(AbstractModel $object)
{
    foreach ($this->relationProcessors as $processor) {
        /**@var $processor RelationInterface*/
        $processor->processRelation($object);
    }
    $this->eventManager->dispatch(
        $object->getEventPrefix(). '_process_relation',
        [
            'object' => $object
        ]
    );
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/etc/di.xml#L416-L423


<virtualType name="CreditmemoRelationsComposite" type="Magento\Framework\Model\ResourceModel\Db\VersionControl\RelationComposite">
    <arguments>
        <argument name="relationProcessors" xsi:type="array">
            <item name="default" xsi:type="object">Magento\Sales\Model\ResourceModel\Order\Creditmemo\Relation</item>
            <item name="creditmemo_refund" xsi:type="object">Magento\Sales\Model\ResourceModel\Order\Creditmemo\Relation\Refund</item>
        </argument>
    </arguments>
</virtualType>

dmitry_fedyuk · February 15, 2016, 12:20am