Ipn Class Reference

Inheritance diagram for Ipn:

Public Member Functions
	__construct (\Magento\Paypal\Model\ConfigFactory $configFactory, \Psr\Log\LoggerInterface $logger, \Magento\Framework\HTTP\Adapter\CurlFactory $curlFactory, \Magento\Sales\Model\OrderFactory $orderFactory, Info $paypalInfo, OrderSender $orderSender, CreditmemoSender $creditmemoSender, array $data=[])
	processIpnRequest ()
	_registerPaymentPending ()
Public Member Functions inherited from AbstractIpn
	__construct (\Magento\Paypal\Model\ConfigFactory $configFactory, \Psr\Log\LoggerInterface $logger, \Magento\Framework\HTTP\Adapter\CurlFactory $curlFactory, array $data=[])
	getRequestData ($key=null)

Protected Member Functions
	_getConfig ()
	_getOrder ()
	_processOrder ()
	_registerDispute ()
	_registerAdjustment ()
	_registerTransaction ()
	_registerPaymentCapture ($skipFraudDetection=false)
	_registerPaymentDenial ()
	_registerPaymentFailure ()
	_registerMasspaymentsSuccess ()
	_registerPaymentReversal ()
	_registerPaymentRefund ()
	_registerPaymentVoid ()
	_importPaymentInformation ()
	_createIpnComment ($comment='', $addToHistory=false)
Protected Member Functions inherited from AbstractIpn
	_postBack ()
	_filterPaymentStatus ($ipnPaymentStatus)
	_debug ()
	_addDebugData ($key, $value)

Protected Attributes
	$_order
	$_orderFactory
	$_paypalInfo
	$orderSender
	$creditmemoSender
Protected Attributes inherited from AbstractIpn
	$_config
	$_ipnRequest
	$_debugData = []
	$_configFactory
	$_curlFactory

Detailed Description

PayPal Instant Payment Notification processor model @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 18 of file Ipn.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Paypal\Model\ConfigFactory	$configFactory,
		\Psr\Log\LoggerInterface	$logger,
		\Magento\Framework\HTTP\Adapter\CurlFactory	$curlFactory,
		\Magento\Sales\Model\OrderFactory	$orderFactory,
		Info	$paypalInfo,
		OrderSender	$orderSender,
		CreditmemoSender	$creditmemoSender,
		array	$data = []
	)

Parameters

\Magento\Paypal\Model\ConfigFactory	$configFactory
\Psr\Log\LoggerInterface	$logger
\Magento\Framework\HTTP\Adapter\CurlFactory	$curlFactory
\Magento\Sales\Model\OrderFactory	$orderFactory
Info	$paypalInfo
OrderSender	$orderSender
CreditmemoSender	$creditmemoSender
array	$data

Definition at line 57 of file Ipn.php.

      {
        parent::__construct($configFactory, $logger, $curlFactory, $data);
        $this->_orderFactory = $orderFactory;
        $this->_paypalInfo = $paypalInfo;
        $this->orderSender = $orderSender;
        $this->creditmemoSender = $creditmemoSender;
    }

Member Function Documentation

_createIpnComment()

_createIpnComment (   $comment = '',   $addToHistory = false  )

protected

Generate an "IPN" comment with additional explanation. Returns the generated comment or order status history object

Parameters

string	$comment
bool	$addToHistory

Returns

string|\Magento\Sales\Model\Order\Status\History

Definition at line 577 of file Ipn.php.

    {
        $message = __('IPN "%1"', $this->getRequestData('payment_status'));
        if ($comment) {
            $message .= ' ' . $comment;
        }
        if ($addToHistory) {
            $message = $this->_order->addStatusHistoryComment($message);
            $message->setIsCustomerNotified(null);
        }
        return $message;
    }

_getConfig()

_getConfig ( )

protected

Get config with the method code and store id and validate

Returns

\Magento\Paypal\Model\Config

Exceptions

Exception

&content_ID= developer/e_howto_admin_IPNIntro

Definition at line 102 of file Ipn.php.

    {
        $order = $this->_getOrder();
        $methodCode = $order->getPayment()->getMethod();
        $parameters = ['params' => [$methodCode, $order->getStoreId()]];
        $this->_config = $this->_configFactory->create($parameters);
        if (!$this->_config->isMethodActive($methodCode) || !$this->_config->isMethodAvailable()) {
            throw new Exception(sprintf('The "%s" method isn\'t available.', $methodCode));
        }
        // verify merchant email intended to receive notification
        $merchantEmail = $this->_config->getValue('businessAccount');
        if (!$merchantEmail) {
            return $this->_config;
        }
        $receiver = $this->getRequestData('business') ?: $this->getRequestData('receiver_email');
        if (strtolower($merchantEmail) != strtolower($receiver)) {
            throw new Exception(
                sprintf(
                    'The requested "%s" and the configured "%s" merchant emails don\'t match.',
                    $receiver,
                    $merchantEmail
                )
            );
        }

        return $this->_config;
    }

_getOrder()

_getOrder ( )

protected

Load order

Returns

\Magento\Sales\Model\Order

Exceptions

Exception

Definition at line 138 of file Ipn.php.

    {
        $incrementId = $this->getRequestData('invoice');
        $this->_order = $this->_orderFactory->create()->loadByIncrementId($incrementId);
        if (!$this->_order->getId()) {
            throw new Exception(sprintf('The "%s" order ID is incorrect. Verify the ID and try again.', $incrementId));
        }
        return $this->_order;
    }

_importPaymentInformation()

_importPaymentInformation ( )

protected

Map payment information from IPN to payment object Returns true if there were changes in information

Returns

bool @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Detect pending payment, frauds TODO: implement logic in one place

See also

\Magento\Paypal\Model\Pro::importPaymentInfo()

Definition at line 510 of file Ipn.php.

    {
        $payment = $this->_order->getPayment();
        $was = $payment->getAdditionalInformation();

        // collect basic information
        $from = [];
        foreach ([
                     Info::PAYER_ID,
                     'payer_email' => Info::PAYER_EMAIL,
                     Info::PAYER_STATUS,
                     Info::ADDRESS_STATUS,
                     Info::PROTECTION_EL,
                     Info::PAYMENT_STATUS,
                     Info::PENDING_REASON,
                 ] as $privateKey => $publicKey) {
            if (is_int($privateKey)) {
                $privateKey = $publicKey;
            }
            $value = $this->getRequestData($privateKey);
            if ($value) {
                $from[$publicKey] = $value;
            }
        }
        if (isset($from['payment_status'])) {
            $from['payment_status'] = $this->_filterPaymentStatus($this->getRequestData('payment_status'));
        }

        // collect fraud filters
        $fraudFilters = [];
        for ($i = 1; $value = $this->getRequestData("fraud_management_pending_filters_{$i}"); $i++) {
            $fraudFilters[] = $value;
        }
        if ($fraudFilters) {
            $from[Info::FRAUD_FILTERS] = $fraudFilters;
        }

        $this->_paypalInfo->importToPayment($from, $payment);

        if (Info::isPaymentReviewRequired($payment)) {
            $payment->setIsTransactionPending(true);
            if ($fraudFilters) {
                $payment->setIsFraudDetected(true);
            }
        }
        if (Info::isPaymentSuccessful($payment)) {
            $payment->setIsTransactionApproved(true);
        } elseif (Info::isPaymentFailed($payment)) {
            $payment->setIsTransactionDenied(true);
        }

        return $was != $payment->getAdditionalInformation();
    }

_processOrder()

_processOrder ( )

protected

IPN workflow implementation Everything should be added to order comments. In positive processing cases customer will get email notifications. Admin will be notified on errors.

Returns

void

Exceptions

Definition at line 156 of file Ipn.php.

    {
        $this->_getConfig();
        try {
            // Handle payment_status
            $transactionType = $this->getRequestData('txn_type');
            switch ($transactionType) {
                // handle new case created
                case Info::TXN_TYPE_NEW_CASE:
                    $this->_registerDispute();
                    break;
                // handle new adjustment is created
                case Info::TXN_TYPE_ADJUSTMENT:
                    $this->_registerAdjustment();
                    break;
                //handle new transaction created
                default:
                    $this->_registerTransaction();
                    break;
            }
        } catch (\Magento\Framework\Exception\LocalizedException $e) {
            $comment = $this->_createIpnComment(__('Note: %1', $e->getMessage()), true);
            $comment->save();
            throw $e;
        }
    }

_registerAdjustment()

_registerAdjustment ( )

protected

Process adjustment notification

Returns

void

Definition at line 210 of file Ipn.php.

    {
        $reasonCode = $this->getRequestData('reason_code');
        $reasonComment = $this->_paypalInfo->explainReasonCode($reasonCode);
        $notificationAmount = $this->_order->getBaseCurrency()->formatTxt($this->getRequestData('mc_gross'));
        // Add IPN comment about registered dispute
        $message = __(
            'IPN "%1". A dispute has been resolved and closed. %2 Transaction amount %3.',
            ucfirst($reasonCode),
            $notificationAmount,
            $reasonComment
        );
        $this->_order->addStatusHistoryComment($message)->setIsCustomerNotified(false)->save();
    }

_registerDispute()

_registerDispute ( )

protected

Process dispute notification

Returns

void

Definition at line 188 of file Ipn.php.

    {
        $reasonComment = $this->_paypalInfo->explainReasonCode($this->getRequestData('reason_code'));
        $caseType = $this->getRequestData('case_type');
        $caseTypeLabel = $this->_paypalInfo->getCaseTypeLabel($caseType);
        $caseId = $this->getRequestData('case_id');
        //Add IPN comment about registered dispute
        $message = __(
            'IPN "%1". Case type "%2". Case ID "%3" %4',
            ucfirst($caseType),
            $caseTypeLabel,
            $caseId,
            $reasonComment
        );
        $this->_order->addStatusHistoryComment($message)->setIsCustomerNotified(false)->save();
    }

_registerMasspaymentsSuccess()

_registerMasspaymentsSuccess ( )

protected

The status "Processed" is used when all Masspayments are successful

Returns

void

Definition at line 414 of file Ipn.php.

    {
        $comment = $this->_createIpnComment('', true);
        $comment->save();
    }

_registerPaymentCapture()

_registerPaymentCapture (   $skipFraudDetection = false )

protected

Process completed payment (either full or partial)

Parameters

bool

$skipFraudDetection

Returns

void

Definition at line 283 of file Ipn.php.

    {
        if ($this->getRequestData('transaction_entity') == 'auth') {
            return;
        }
        $parentTransactionId = $this->getRequestData('parent_txn_id');
        $this->_importPaymentInformation();
        $payment = $this->_order->getPayment();
        $payment->setTransactionId($this->getRequestData('txn_id'));
        $payment->setCurrencyCode($this->getRequestData('mc_currency'));
        $payment->setPreparedMessage($this->_createIpnComment(''));
        $payment->setParentTransactionId($parentTransactionId);
        $payment->setShouldCloseParentTransaction('Completed' === $this->getRequestData('auth_status'));
        $payment->setIsTransactionClosed(0);
        $payment->registerCaptureNotification(
            $this->getRequestData('mc_gross'),
            $skipFraudDetection && $parentTransactionId
        );
        $this->_order->save();

        // notify customer
        $invoice = $payment->getCreatedInvoice();
        if ($invoice && !$this->_order->getEmailSent()) {
            $this->orderSender->send($this->_order);
            $this->_order->addStatusHistoryComment(
                __('You notified customer about invoice #%1.', $invoice->getIncrementId())
            )
                ->setIsCustomerNotified(true)
                ->save();
        }
    }

_registerPaymentDenial()

_registerPaymentDenial ( )

protected

Process denied payment notification

Returns

void

Exceptions

Exception

Definition at line 321 of file Ipn.php.

    {
        try {
            $this->_importPaymentInformation();
            $this->_order->getPayment()
                ->setTransactionId($this->getRequestData('txn_id'))
                ->setNotificationResult(true)
                ->setIsTransactionClosed(true)
                ->deny(false);
            $this->_order->save();
        } catch (LocalizedException $e) {
            if ($e->getMessage() != __('We cannot cancel this order.')) {
                throw $e;
            }
        }
    }

_registerPaymentFailure()

_registerPaymentFailure ( )

protected

Treat failed payment as order cancellation

Returns

void

Definition at line 343 of file Ipn.php.

    {
        $this->_importPaymentInformation();
        $this->_order->registerCancellation($this->_createIpnComment(''))->save();
    }

_registerPaymentPending()

_registerPaymentPending

(

)

Process payment pending notification

Returns

void

Exceptions

Exception

Definition at line 355 of file Ipn.php.

    {
        $reason = $this->getRequestData('pending_reason');
        if ('authorization' === $reason) {
            $this->_registerPaymentAuthorization();
            return;
        }
        if ('order' === $reason) {
            throw new Exception('The "order" authorizations aren\'t implemented.');
        }
        // case when was placed using PayPal standard
        if (\Magento\Sales\Model\Order::STATE_PENDING_PAYMENT == $this->_order->getState()
            && !$this->getRequestData('transaction_entity')
        ) {
            $this->_registerPaymentCapture();
            return;
        }

        $this->_importPaymentInformation();

        $this->_order->getPayment()
            ->setPreparedMessage($this->_createIpnComment($this->_paypalInfo->explainPendingReason($reason)))
            ->setTransactionId($this->getRequestData('txn_id'))
            ->setIsTransactionClosed(0)
            ->update(false);
        $this->_order->save();
    }

_registerPaymentRefund()

_registerPaymentRefund ( )

protected

Process a refund

Returns

void

Definition at line 455 of file Ipn.php.

    {
        $this->_importPaymentInformation();
        $reason = $this->getRequestData('reason_code');
        $isRefundFinal = !$this->_paypalInfo->isReversalDisputable($reason);
        $payment = $this->_order->getPayment()
            ->setPreparedMessage($this->_createIpnComment($this->_paypalInfo->explainReasonCode($reason)))
            ->setTransactionId($this->getRequestData('txn_id'))
            ->setParentTransactionId($this->getRequestData('parent_txn_id'))
            ->setIsTransactionClosed($isRefundFinal)
            ->registerRefundNotification(-1 * $this->getRequestData('mc_gross'));
        $this->_order->save();

        // TODO: there is no way to close a capture right now

        $creditMemo = $payment->getCreatedCreditmemo();
        if ($creditMemo) {
            $this->creditmemoSender->send($creditMemo);
            $this->_order->addStatusHistoryComment(
                __('You notified customer about creditmemo #%1.', $creditMemo->getIncrementId())
            )
                ->setIsCustomerNotified(true)
                ->save();
        }
    }

_registerPaymentReversal()

_registerPaymentReversal ( )

protected

Process payment reversal and cancelled reversal notification

Returns

void

Definition at line 425 of file Ipn.php.

    {
        $reasonCode = $this->getRequestData('reason_code');
        $reasonComment = $this->_paypalInfo->explainReasonCode($reasonCode);
        $notificationAmount = $this->_order->getBaseCurrency()
            ->formatTxt(
                $this->getRequestData('mc_gross') + $this->getRequestData('mc_fee')
            );
        $paymentStatus = $this->_filterPaymentStatus($this->getRequestData('payment_status'));
        $orderStatus = $paymentStatus ==
        Info::PAYMENTSTATUS_REVERSED ? Info::ORDER_STATUS_REVERSED : Info::ORDER_STATUS_CANCELED_REVERSAL;
        //Change order status to PayPal Reversed/PayPal Cancelled Reversal if it is possible.
        $message = __(
            'IPN "%1". %2 Transaction amount %3. Transaction ID: "%4"',
            $this->getRequestData('payment_status'),
            $reasonComment,
            $notificationAmount,
            $this->getRequestData('txn_id')
        );
        $this->_order->setStatus($orderStatus);
        $this->_order->addStatusHistoryComment($message, $orderStatus)
            ->setIsCustomerNotified(false)
            ->save();
    }

_registerPaymentVoid()

_registerPaymentVoid ( )

protected

Process voided authorization

Returns

void

Definition at line 486 of file Ipn.php.

    {
        $this->_importPaymentInformation();

        $parentTxnId = $this->getRequestData('transaction_entity') == 'auth'
            ? $this->getRequestData('txn_id')
            : $this->getRequestData('parent_txn_id');

        $this->_order->getPayment()
            ->setPreparedMessage($this->_createIpnComment(''))
            ->setParentTransactionId($parentTxnId)
            ->registerVoidNotification();

        $this->_order->save();
    }

_registerTransaction()

_registerTransaction ( )

protected

Process regular IPN notifications

Returns

void

Exceptions

Definition at line 233 of file Ipn.php.

    {
        // Handle payment_status
        $paymentStatus = $this->_filterPaymentStatus($this->getRequestData('payment_status'));
        switch ($paymentStatus) {
            // paid
            case Info::PAYMENTSTATUS_COMPLETED:
                $this->_registerPaymentCapture(true);
                break;
            // the holded payment was denied on paypal side
            case Info::PAYMENTSTATUS_DENIED:
                $this->_registerPaymentDenial();
                break;
            // customer attempted to pay via bank account, but failed
            case Info::PAYMENTSTATUS_FAILED:
                // cancel order
                $this->_registerPaymentFailure();
                break;
            // payment was obtained, but money were not captured yet
            case Info::PAYMENTSTATUS_PENDING:
                $this->_registerPaymentPending();
                break;
            case Info::PAYMENTSTATUS_PROCESSED:
                $this->_registerMasspaymentsSuccess();
                break;
            case Info::PAYMENTSTATUS_REVERSED:
                //break is intentionally omitted
            case Info::PAYMENTSTATUS_UNREVERSED:
                $this->_registerPaymentReversal();
                break;
            case Info::PAYMENTSTATUS_REFUNDED:
                $this->_registerPaymentRefund();
                break;
            // authorization expire/void
            case Info::PAYMENTSTATUS_EXPIRED:
                // break is intentionally omitted
            case Info::PAYMENTSTATUS_VOIDED:
                $this->_registerPaymentVoid();
                break;
            default:
                throw new Exception("The '{$paymentStatus}' payment status couldn't be handled.");
        }
    }

processIpnRequest()

processIpnRequest

(

)

Get ipn data, send verification to PayPal, run corresponding handler

Returns

void

Exceptions

Exception

Implements IpnInterface.

Definition at line 80 of file Ipn.php.

    {
        $this->_addDebugData('ipn', $this->getRequestData());

        try {
            $this->_getConfig();
            $this->_postBack();
            $this->_processOrder();
        } catch (Exception $e) {
            $this->_addDebugData('exception', $e->getMessage());
            $this->_debug();
            throw $e;
        }
        $this->_debug();
    }

Field Documentation

$_order

$_order

protected

Definition at line 23 of file Ipn.php.

$_orderFactory

$_orderFactory

protected

Definition at line 28 of file Ipn.php.

$_paypalInfo

$_paypalInfo

protected

Definition at line 35 of file Ipn.php.

$creditmemoSender

$creditmemoSender

protected

Definition at line 45 of file Ipn.php.

$orderSender

$orderSender

protected

Definition at line 40 of file Ipn.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-paypal/Model/Ipn.php