Pro Class Reference

Inheritance diagram for Pro:

Public Member Functions
	__construct (\Magento\Paypal\Model\Config\Factory $configFactory, \Magento\Paypal\Model\Api\Type\Factory $apiFactory, \Magento\Paypal\Model\InfoFactory $infoFactory, TransactionRepositoryInterface $transactionRepository)
	setMethod ($code, $storeId=null)
	setConfig (\Magento\Paypal\Model\Config $instance, $storeId=null)
	getConfig ()
	getApi ()
	resetApi ()
	getInfo ()
	importPaymentInfo (\Magento\Framework\DataObject $from, \Magento\Payment\Model\InfoInterface $to)
	void (\Magento\Framework\DataObject $payment)
	capture (\Magento\Framework\DataObject $payment, $amount)
	refund (\Magento\Framework\DataObject $payment, $amount)
	cancel (\Magento\Framework\DataObject $payment)
	canReviewPayment (\Magento\Payment\Model\InfoInterface $payment)
	reviewPayment (\Magento\Payment\Model\InfoInterface $payment, $action)
	fetchTransactionInfo (\Magento\Payment\Model\InfoInterface $payment, $transactionId)

Data Fields
const	PAYMENT_REVIEW_ACCEPT = 'accept'
const	PAYMENT_REVIEW_DENY = 'deny'

Protected Member Functions
	_isPaymentReviewRequired (\Magento\Payment\Model\InfoInterface $payment)
	_importCaptureResultToPayment ($api, $payment)
	_importRefundResultToPayment ($api, $payment, $canRefundMore)
	_getParentTransactionId (\Magento\Framework\DataObject $payment)

Protected Attributes
	$_config
	$_api
	$_infoInstance
	$_apiType = \Magento\Paypal\Model\Api\Nvp::class
	$_configType = \Magento\Paypal\Model\Config::class
	$_configFactory
	$_apiFactory
	$_infoFactory
	$transactionRepository

Detailed Description

PayPal Website Payments Pro implementation for payment method instances This model was created because right now PayPal Direct and PayPal Express payment methods cannot have same abstract

Definition at line 17 of file Pro.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Paypal\Model\Config\Factory	$configFactory,
		\Magento\Paypal\Model\Api\Type\Factory	$apiFactory,
		\Magento\Paypal\Model\InfoFactory	$infoFactory,
		TransactionRepositoryInterface	$transactionRepository
	)

Parameters

\Magento\Paypal\Model\Config\Factory	$configFactory
\Magento\Paypal\Model\Api\Type\Factory	$apiFactory
\Magento\Paypal\Model\InfoFactory	$infoFactory
TransactionRepositoryInterface	$transactionRepository

Definition at line 87 of file Pro.php.

      {
        $this->_configFactory = $configFactory;
        $this->_apiFactory = $apiFactory;
        $this->_infoFactory = $infoFactory;
        $this->transactionRepository = $transactionRepository;
    }

Member Function Documentation

_getParentTransactionId()

_getParentTransactionId ( \Magento\Framework\DataObject  $payment )

protected

Parent transaction id getter

Parameters

\Magento\Framework\DataObject

$payment

Returns

string

Definition at line 432 of file Pro.php.

    {
        return $payment->getParentTransactionId();
    }

_importCaptureResultToPayment()

_importCaptureResultToPayment (   $api,   $payment  )

protected

Import capture results to payment

Parameters

\Magento\Paypal\Model\Api\Nvp	$api
\Magento\Sales\Model\Order\Payment	$payment

Returns

void

Definition at line 400 of file Pro.php.

    {
        $payment->setTransactionId($api->getTransactionId())->setIsTransactionClosed(false);
        $this->importPaymentInfo($api, $payment);
    }

_importRefundResultToPayment()

_importRefundResultToPayment (   $api,   $payment,   $canRefundMore  )

protected

Import refund results to payment

Parameters

\Magento\Paypal\Model\Api\Nvp	$api
\Magento\Sales\Model\Order\Payment	$payment
bool	$canRefundMore

Returns

void

Definition at line 414 of file Pro.php.

    {
        $payment->setTransactionId(
            $api->getRefundTransactionId()
        )->setIsTransactionClosed(
            1 // refund initiated by merchant
        )->setShouldCloseParentTransaction(
            !$canRefundMore
        );
        $this->importPaymentInfo($api, $payment);
    }

_isPaymentReviewRequired()

_isPaymentReviewRequired ( \Magento\Payment\Model\InfoInterface  $payment )

protected

Check whether payment review is required

Parameters

\Magento\Payment\Model\InfoInterface

$payment

Returns

bool

Definition at line 347 of file Pro.php.

    {
        return Info::isPaymentReviewRequired($payment);
    }

cancel()

cancel

(

\Magento\Framework\DataObject

$payment

)

Cancel payment

Parameters

\Magento\Framework\DataObject

$payment

Returns

void

Definition at line 320 of file Pro.php.

    {
        if (!$payment->getOrder()->getInvoiceCollection()->count()) {
            $this->void($payment);
        }
    }

canReviewPayment()

canReviewPayment

(

\Magento\Payment\Model\InfoInterface

$payment

)

Check whether can do payment review

Parameters

\Magento\Payment\Model\InfoInterface

$payment

Returns

bool

Definition at line 333 of file Pro.php.

    {
        $pendingReason = $payment->getAdditionalInformation(\Magento\Paypal\Model\Info::PENDING_REASON_GLOBAL);
        return $this->_isPaymentReviewRequired(
            $payment
        ) && $pendingReason != \Magento\Paypal\Model\Info::PAYMENTSTATUS_REVIEW;
    }

capture()

capture	(	\Magento\Framework\DataObject	$payment,
			$amount
	)

Attempt to capture payment Will return false if the payment is not supposed to be captured

Parameters

\Magento\Framework\DataObject	$payment
float	$amount

Returns

false|null

Definition at line 251 of file Pro.php.

    {
        $authTransactionId = $this->_getParentTransactionId($payment);
        if (!$authTransactionId) {
            return false;
        }
        $api = $this->getApi()
            ->setAuthorizationId($authTransactionId)
            ->setIsCaptureComplete($payment->isCaptureFinal($amount))
            ->setAmount($amount);

        $order = $payment->getOrder();
        $orderIncrementId = $order->getIncrementId();
        $api->setCurrencyCode($order->getBaseCurrencyCode())
            ->setInvNum($orderIncrementId)
            ->setCustref($orderIncrementId)
            ->setPonum($order->getId());
        // TODO: pass 'NOTE' to API

        $api->callDoCapture();
        $this->_importCaptureResultToPayment($api, $payment);
    }

fetchTransactionInfo()

fetchTransactionInfo	(	\Magento\Payment\Model\InfoInterface	$payment,
			$transactionId
	)

Fetch transaction details info

Parameters

\Magento\Payment\Model\InfoInterface	$payment
string	$transactionId

Returns

array

Definition at line 384 of file Pro.php.

    {
        $api = $this->getApi()->setTransactionId($transactionId)->setRawResponseNeeded(true);
        $api->callGetTransactionDetails();
        $this->importPaymentInfo($api, $payment);
        $data = $api->getRawSuccessResponseData();
        return $data ? $data : [];
    }

getApi()

getApi

(

)

API instance getter Sets current store id to current config instance and passes it to API

Returns

\Magento\Paypal\Model\Api\Nvp

Definition at line 155 of file Pro.php.

    {
        if (null === $this->_api) {
            $this->_api = $this->_apiFactory->create($this->_apiType);
        }
        $this->_api->setConfigObject($this->_config);
        return $this->_api;
    }

getConfig()

getConfig

(

)

Config instance getter

Returns

\Magento\Paypal\Model\Config

Definition at line 144 of file Pro.php.

    {
        return $this->_config;
    }

getInfo()

getInfo

(

)

Instantiate and return info model

Returns

\Magento\Paypal\Model\Info

Definition at line 181 of file Pro.php.

    {
        if (null === $this->_infoInstance) {
            $this->_infoInstance = $this->_infoFactory->create();
        }
        return $this->_infoInstance;
    }

importPaymentInfo()

importPaymentInfo	(	\Magento\Framework\DataObject	$from,
		\Magento\Payment\Model\InfoInterface	$to
	)

Transfer transaction/payment information from API instance to order payment

Parameters

\Magento\Framework\DataObject | AbstractApi	$from
\Magento\Payment\Model\InfoInterface	$to

Returns

$this

Detect payment review and/or frauds PayPal pro API returns fraud results only in the payment call response

Definition at line 196 of file Pro.php.

    {
        // update PayPal-specific payment information in the payment object
        $this->getInfo()->importToPayment($from, $to);

        if ($from->getDataUsingMethod(\Magento\Paypal\Model\Info::IS_FRAUD)) {
            $to->setIsTransactionPending(true);
            $to->setIsFraudDetected(true);
        } elseif (Info::isPaymentReviewRequired($to)) {
            $to->setIsTransactionPending(true);
        }

        // give generic info about transaction state
        if (Info::isPaymentSuccessful($to)) {
            $to->setIsTransactionApproved(true);
        } elseif (Info::isPaymentFailed($to)) {
            $to->setIsTransactionDenied(true);
        }

        return $this;
    }

refund()

refund	(	\Magento\Framework\DataObject	$payment,
			$amount
	)

Refund a capture transaction

Parameters

\Magento\Framework\DataObject	$payment
float	$amount

Returns

void

Exceptions

Definition at line 282 of file Pro.php.

    {
        $captureTxnId = $this->_getParentTransactionId($payment);
        if ($captureTxnId) {
            $api = $this->getApi();
            $order = $payment->getOrder();
            $api->setPayment(
                $payment
            )->setTransactionId(
                $captureTxnId
            )->setAmount(
                $amount
            )->setCurrencyCode(
                $order->getBaseCurrencyCode()
            );
            $canRefundMore = $payment->getCreditmemo()->getInvoice()->canRefund();
            $isFullRefund = !$canRefundMore &&
                0 == (double)$order->getBaseTotalOnlineRefunded() + (double)$order->getBaseTotalOfflineRefunded();
            $api->setRefundType(
                $isFullRefund
                    ? \Magento\Paypal\Model\Config::REFUND_TYPE_FULL
                    : \Magento\Paypal\Model\Config::REFUND_TYPE_PARTIAL
            );
            $api->callRefundTransaction();
            $this->_importRefundResultToPayment($api, $payment, $canRefundMore);
        } else {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('We can\'t issue a refund transaction because there is no capture transaction.')
            );
        }
    }

resetApi()

resetApi

(

)

Destroy existing NVP Api object

Returns

$this

Definition at line 169 of file Pro.php.

    {
        $this->_api = null;

        return $this;
    }

reviewPayment()

reviewPayment	(	\Magento\Payment\Model\InfoInterface	$payment,
			$action
	)

Perform the payment review

Parameters

\Magento\Payment\Model\InfoInterface	$payment
string	$action

Returns

bool

Definition at line 359 of file Pro.php.

    {
        $api = $this->getApi()->setTransactionId($payment->getLastTransId());

        // check whether the review is still needed
        $api->callGetTransactionDetails();
        $this->importPaymentInfo($api, $payment);
        if (!Info::isPaymentReviewRequired($payment)) {
            return false;
        }

        // perform the review action
        $api->setAction($action)->callManagePendingTransactionStatus();
        $api->callGetTransactionDetails();
        $this->importPaymentInfo($api, $payment);
        return true;
    }

setConfig()

setConfig	(	\Magento\Paypal\Model\Config	$instance,
			$storeId = null
	)

Config instance setter

Parameters

\Magento\Paypal\Model\Config	$instance
int | null	$storeId

Returns

$this

Definition at line 130 of file Pro.php.

    {
        $this->_config = $instance;
        if (null !== $storeId) {
            $this->_config->setStoreId($storeId);
        }
        return $this;
    }

setMethod()

setMethod	(		$code,
			$storeId = null
	)

Payment method code setter. Also instantiates/updates config

Parameters

string	$code
int | null	$storeId

Returns

$this

Definition at line 106 of file Pro.php.

    {
        if (null === $this->_config) {
            $params = [$code];
            if (null !== $storeId) {
                $params[] = $storeId;
            }
            $this->_config = $this->_configFactory->create($this->_configType, ['params' => $params]);
        } else {
            $this->_config->setMethod($code);
            if (null !== $storeId) {
                $this->_config->setStoreId($storeId);
            }
        }
        return $this;
    }

void()

void

(

\Magento\Framework\DataObject

$payment

)

Void transaction

Parameters

\Magento\Framework\DataObject

$payment

Returns

void

Exceptions

Definition at line 229 of file Pro.php.

    {
        $authTransactionId = $this->_getParentTransactionId($payment);
        if ($authTransactionId) {
            $api = $this->getApi();
            $api->setPayment($payment)->setAuthorizationId($authTransactionId)->callDoVoid();
            $this->importPaymentInfo($api, $payment);
        } else {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('You need an authorization transaction to void.')
            );
        }
    }

Field Documentation

$_api

$_api

protected

Definition at line 38 of file Pro.php.

$_apiFactory

$_apiFactory

protected

Definition at line 69 of file Pro.php.

$_apiType

$_apiType = \Magento\Paypal\Model\Api\Nvp::class

protected

Definition at line 52 of file Pro.php.

$_config

$_config

protected

Definition at line 31 of file Pro.php.

$_configFactory

$_configFactory

protected

Definition at line 64 of file Pro.php.

$_configType

$_configType = \Magento\Paypal\Model\Config::class

protected

Definition at line 59 of file Pro.php.

$_infoFactory

$_infoFactory

protected

Definition at line 74 of file Pro.php.

$_infoInstance

$_infoInstance

protected

Definition at line 45 of file Pro.php.

$transactionRepository

$transactionRepository

protected

Definition at line 79 of file Pro.php.

PAYMENT_REVIEW_ACCEPT

const PAYMENT_REVIEW_ACCEPT = 'accept'

Possible payment review actions (for FMF only)

Definition at line 22 of file Pro.php.

PAYMENT_REVIEW_DENY

const PAYMENT_REVIEW_DENY = 'deny'

Definition at line 24 of file Pro.php.

---

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

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