Credit Memo

Credit Memo Service

namespace Magento\Sales\Model\Service;

class CreditmemoService
{
    public function __construct(
        private \Magento\Sales\Api\CreditmemoRepositoryInterface $creditmemoRepository,
        private \Magento\Sales\Api\Data\CreditmemoInterfaceFactory $creditmemoFactory
    ) {}

    public function createCreditmemo(
        \Magento\Sales\Api\Data\OrderInterface $order,
        array $items = [],
        bool $offline = true
    ): \Magento\Sales\Api\Data\CreditmemoInterface {
        $creditmemo = $this->creditmemoFactory->create();
        $creditmemo->setOrderId($order->getEntityId());
        $creditmemo->setStoreId($order->getStoreId());

        // Add items
        if (empty($items)) {
            // Refund all invoiced items
            foreach ($order->getItems() as $item) {
                $this->addItemToCreditmemo($creditmemo, $item);
            }
        } else {
            // Partial refund
            foreach ($items as $itemId => $qty) {
                $item = $order->getItemById($itemId);
                if ($item) {
                    $this->addItemToCreditmemo($creditmemo, $item, $qty);
                }
            }
        }

        // Calculate totals
        $creditmemo->collectTotals();

        // Set refund type
        $creditmemo->setOffline($offline);

        $this->creditmemoRepository->save($creditmemo);

        return $creditmemo;
    }
}

Credit Memo Items

private function addItemToCreditmemo(
    \Magento\Sales\Api\Data\CreditmemoInterface $creditmemo,
    \Magento\Sales\Api\Data\OrderItemInterface $orderItem,
    float $qty = null
): void {
    $creditmemoItem = $this->creditmemoItemFactory->create();
    $creditmemoItem->setOrderItem($orderItem);
    $creditmemoItem->setQty($qty ?? $orderItem->getQtyInvoiced());

    $creditmemo->addItem($creditmemoItem);
}

Partial Refund Implementation

// Refund specific items only
$items = [
    1 => 1,  // item_id 1, refund qty 1
    3 => 2,  // item_id 3, refund qty 2
];

$creditmemo = $this->creditmemoService->createCreditmemo($order, $items);

// Check refund status
foreach ($order->getItems() as $item) {
    $refundedQty = $item->getQtyRefunded();
    $remaining = $item->getQtyInvoiced() - $refundedQty;

    if ($remaining > 0) {
        echo "Item {$item->getId()}: {$remaining} can still be refunded\n";
    }
}

Multiple Credit Memos

// First refund - items 1 and 2
$creditmemo1 = $this->creditmemoService->createCreditmemo(
    $order,
    [1 => 1, 2 => 1],
    true // offline
);

// Second refund - remaining items
$creditmemo2 = $this->creditmemoService->createCreditmemo(
    $order,
    [2 => 1], // remaining qty
    false // online (gateway refund)
);

Refund Eligibility

// Check if order can be refunded
if ($order->canCreditmemo()) {
    // Refund is possible
}

// Check remaining refundable qty
foreach ($order->getItems() as $item) {
    $refundable = $item->getQtyInvoiced() - $item->getQtyRefunded();
    if ($refundable > 0) {
        // Item can still be refunded
    }
}

Offline Refund

// Offline refund - no gateway interaction
$creditmemo = $this->creditmemoService->createCreditmemo(
    $order,
    [],
    true // offline = true
);

// Manually mark as refunded
$creditmemo->setState(\Magento\Sales\Model\Order\Creditmemo::STATE_REFUNDED);
$this->creditmemoRepository->save($creditmemo);

Online Refund (Gateway)

// Online refund - call payment gateway
$creditmemo = $this->creditmemoService->createCreditmemo(
    $order,
    [],
    false // offline = false
);

// Process through payment method
$payment = $order->getPayment();
$method = $this->paymentMethodPool->getMethod($payment->getMethod());

if ($method->canRefund()) {
    $method->refund($payment, $creditmemo->getGrandTotal());
}

// Save with refund transaction
$creditmemo->setState(\Magento\Sales\Model\Order\Creditmemo::STATE_REFUNDED);
$this->creditmemoRepository->save($creditmemo);

Refund Amounts

// Credit memo amounts
$creditmemo->setSubtotal($refundSubtotal);
$creditmemo->setBaseSubtotal($refundSubtotal);
$creditmemo->setAdjustment($adjustmentFee);
$creditmemo->setBaseAdjustment($adjustmentFee);
$creditmemo->setGrandTotal($refundTotal);
$creditmemo->setBaseGrandTotal($refundTotal);

Item-Level Refunds

// Get refundable items
$refundableItems = [];
foreach ($order->getItems() as $item) {
    $refundable = $item->getQtyInvoiced() - $item->getQtyRefunded();
    if ($refundable > 0) {
        $refundableItems[$item->getId()] = [
            'name' => $item->getName(),
            'sku' => $item->getSku(),
            'refundable_qty' => $refundable,
            'price' => $item->getPrice(),
            'row_total' => $item->getRowTotal(),
        ];
    }
}

Refund Totals Calculation

// Calculate refund totals
$subtotal = 0;
$tax = 0;
$shipping = 0;

foreach ($creditmemo->getItems() as $item) {
    $subtotal += $item->getRowTotal();
    $tax += $item->getTaxAmount();
}

// Add shipping refund if applicable
if ($creditmemo->getShippingAmount() > 0) {
    $shipping = $creditmemo->getShippingAmount();
}

$grandTotal = $subtotal + $tax + $shipping - $creditmemo->getAdjustment();

$creditmemo->setSubtotal($subtotal);
$creditmemo->setTaxAmount($tax);
$creditmemo->setShippingAmount($shipping);
$creditmemo->setGrandTotal($grandTotal);