Payflowlink Class Reference

Inheritance diagram for Payflowlink:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory, \Magento\Payment\Helper\Data $paymentData, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Payment\Model\Method\Logger $logger, \Magento\Framework\Module\ModuleListInterface $moduleList, \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate, \Magento\Store\Model\StoreManagerInterface $storeManager, ConfigInterfaceFactory $configFactory, \Magento\Paypal\Model\Payflow\Service\Gateway $gateway, HandlerInterface $errorHandler, \Magento\Framework\Math\Random $mathRandom, \Magento\Paypal\Model\Payflow\RequestFactory $requestFactory, \Magento\Quote\Api\CartRepositoryInterface $quoteRepository, \Magento\Sales\Model\OrderFactory $orderFactory, \Magento\Framework\App\RequestInterface $requestHttp, \Magento\Store\Model\WebsiteFactory $websiteFactory, OrderSender $orderSender, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
	validate ()
	isAvailable (\Magento\Quote\Api\Data\CartInterface $quote=null)
	isActive ($storeId=null)
	getResponse ()
	process ($responseData)
Public Member Functions inherited from Payflowpro
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory, \Magento\Payment\Helper\Data $paymentData, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Payment\Model\Method\Logger $logger, \Magento\Framework\Module\ModuleListInterface $moduleList, \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate, \Magento\Store\Model\StoreManagerInterface $storeManager, ConfigInterfaceFactory $configFactory, Gateway $gateway, HandlerInterface $errorHandler, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
	isAvailable (\Magento\Quote\Api\Data\CartInterface $quote=null)
	isActive ($storeId=null)
	getConfigPaymentAction ()
	authorize (\Magento\Payment\Model\InfoInterface $payment, $amount)
	capture (\Magento\Payment\Model\InfoInterface $payment, $amount)
	void (\Magento\Payment\Model\InfoInterface $payment)
	canVoid ()
	cancel (\Magento\Payment\Model\InfoInterface $payment)
	refund (\Magento\Payment\Model\InfoInterface $payment, $amount)
	fetchTransactionInfo (InfoInterface $payment, $transactionId)
	getConfig ()
	postRequest (DataObject $request, ConfigInterface $config)
	processErrors (DataObject $response)
	acceptPayment (InfoInterface $payment)
	denyPayment (InfoInterface $payment)
	reviewPayment (InfoInterface $payment, $action)
	setBilling (DataObject $request, $billing)
	setShipping ($request, $shipping)
	mapGatewayResponse (array $postData, DataObject $response)
	setTransStatus ($payment, $response)
	fillCustomerContacts (DataObject $order, DataObject $request)
	addRequestOrderInfo (DataObject $request, Order $order)
	assignData (DataObject $data)

Data Fields
const	LAYOUT_TEMPLATE = 'mobile'
const	TRANSACTION_PAYFLOW_URL = 'https://payflowlink.paypal.com/'
const	RESPONSE_ERROR_MSG = 'Payment error. %s was not found.'
Data Fields inherited from Payflowpro
const	TRXTYPE_AUTH_ONLY = 'A'
const	TRXTYPE_SALE = 'S'
const	TRXTYPE_CREDIT = 'C'
const	TRXTYPE_DELAYED_CAPTURE = 'D'
const	TRXTYPE_DELAYED_VOID = 'V'
const	TRXTYPE_DELAYED_VOICE = 'F'
const	TRXTYPE_DELAYED_INQUIRY = 'I'
const	TRXTYPE_ACCEPT_DENY = 'U'
const	UPDATEACTION_APPROVED = 'APPROVE'
const	UPDATEACTION_DECLINED_BY_MERCHANT = 'FPS_MERCHANT_DECLINE'
const	TENDER_CC = 'C'
const	TRANSACTION_URL = 'https://payflowpro.paypal.com/transaction'
const	TRANSACTION_URL_TEST_MODE = 'https://pilot-payflowpro.paypal.com/transaction'
const	RESPONSE_CODE_APPROVED = 0
const	RESPONSE_CODE_INVALID_AMOUNT = 4
const	RESPONSE_CODE_FRAUDSERVICE_FILTER = 126
const	RESPONSE_CODE_DECLINED = 12
const	RESPONSE_CODE_DECLINED_BY_FILTER = 125
const	RESPONSE_CODE_DECLINED_BY_MERCHANT = 128
const	RESPONSE_CODE_CAPTURE_ERROR = 111
const	RESPONSE_CODE_VOID_ERROR = 108
const	PNREF = 'pnref'

Protected Member Functions
	_processOrder (\Magento\Sales\Model\Order $order)
	_getOrderFromResponse ()
	_buildTokenRequest (\Magento\Sales\Model\Order\Payment $payment)
	_getStoreId ()
	_getTrxTokenType ()
	_processTokenErrors ($response, $payment)
	_getSecureSilentPostHash ($payment)
	_generateSecureSilentPostHash ($payment)
Protected Member Functions inherited from Payflowpro
	_getCaptureAmount ($amount)
	_buildPlaceRequest (DataObject $payment, $amount)
	transactionInquiryRequest (InfoInterface $payment, $transactionId)

Protected Attributes
	$_callbackController = 'payflow'
	$_code = \Magento\Paypal\Model\Config::METHOD_PAYFLOWLINK
	$_formBlockType = \Magento\Paypal\Block\Payflow\Link\Form::class
	$_infoBlockType = \Magento\Paypal\Block\Payment\Info::class
	$_canUseInternal = false
	$_isInitializeNeeded = true
	$_response
	$_secureSilentPostHashKey = 'secure_silent_post_hash'
	$_requestFactory
	$quoteRepository
	$_orderFactory
	$_websiteFactory
	$orderSender
Protected Attributes inherited from Payflowpro
	$_responseParamsMappings
	$_code = \Magento\Paypal\Model\Config::METHOD_PAYFLOWPRO
	$_isGateway = true
	$_canAuthorize = true
	$_canCapture = true
	$_canCapturePartial = true
	$_canRefund = true
	$_canRefundInvoicePartial = true
	$_canVoid = true
	$_canUseInternal = true
	$_canUseCheckout = true
	$_canSaveCc = false
	$_isProxy = false
	$_canFetchTransactionInfo = true
	$_canReviewPayment = true
	$_clientTimeout = 45
	$_debugReplacePrivateDataKeys = ['user', 'pwd', 'acct', 'expdate', 'cvv2']
	$storeManager
	$configFactory

Additional Inherited Members
Static Protected Member Functions inherited from Payflowpro
static	_isTransactionUnderReview ($status)

Detailed Description

Payflow Link payment gateway model @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 20 of file Payflowlink.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory,
		\Magento\Framework\Api\AttributeValueFactory	$customAttributeFactory,
		\Magento\Payment\Helper\Data	$paymentData,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Payment\Model\Method\Logger	$logger,
		\Magento\Framework\Module\ModuleListInterface	$moduleList,
		\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$localeDate,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		ConfigInterfaceFactory	$configFactory,
		\Magento\Paypal\Model\Payflow\Service\Gateway	$gateway,
		HandlerInterface	$errorHandler,
		\Magento\Framework\Math\Random	$mathRandom,
		\Magento\Paypal\Model\Payflow\RequestFactory	$requestFactory,
		\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository,
		\Magento\Sales\Model\OrderFactory	$orderFactory,
		\Magento\Framework\App\RequestInterface	$requestHttp,
		\Magento\Store\Model\WebsiteFactory	$websiteFactory,
		OrderSender	$orderSender,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = null,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = null,
		array	$data = []
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory
\Magento\Framework\Api\AttributeValueFactory	$customAttributeFactory
\Magento\Payment\Helper\Data	$paymentData
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Payment\Model\Method\Logger	$logger
\Magento\Framework\Module\ModuleListInterface	$moduleList
\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$localeDate
\Magento\Store\Model\StoreManagerInterface	$storeManager
ConfigInterfaceFactory	$configFactory
Payflow\Service\Gateway	$gateway
HandlerInterface	$errorHandler
\Magento\Framework\Math\Random	$mathRandom
Payflow\RequestFactory	$requestFactory
\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository
\Magento\Sales\Model\OrderFactory	$orderFactory
\Magento\Framework\App\RequestInterface	$requestHttp
\Magento\Store\Model\WebsiteFactory	$websiteFactory
OrderSender	$orderSender
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 145 of file Payflowlink.php.

      {
        $this->_requestFactory = $requestFactory;
        $this->quoteRepository = $quoteRepository;
        $this->_orderFactory = $orderFactory;
        $this->_requestHttp = $requestHttp;
        $this->_websiteFactory = $websiteFactory;
        $this->orderSender = $orderSender;
        parent::__construct(
            $context,
            $registry,
            $extensionFactory,
            $customAttributeFactory,
            $paymentData,
            $scopeConfig,
            $logger,
            $moduleList,
            $localeDate,
            $storeManager,
            $configFactory,
            $gateway,
            $errorHandler,
            $resource,
            $resourceCollection,
            $data
        );
        $this->mathRandom = $mathRandom;
    }

Member Function Documentation

_buildTokenRequest()

_buildTokenRequest ( \Magento\Sales\Model\Order\Payment  $payment )

protected

Build request for getting token

Parameters

\Magento\Sales\Model\Order\Payment

$payment

Returns

\Magento\Framework\DataObject

Definition at line 422 of file Payflowlink.php.

    {
        $request = $this->buildBasicRequest();
        $request->setCreatesecuretoken('Y')
            ->setSecuretokenid($this->mathRandom->getUniqueHash())
            ->setTrxtype($this->_getTrxTokenType());

        $order = $payment->getOrder();
        $request->setAmt(sprintf('%.2F', $order->getBaseTotalDue()))
            ->setCurrency($order->getBaseCurrencyCode());
        $this->addRequestOrderInfo($request, $order);

        $request = $this->fillCustomerContacts($order, $request);
        //pass store Id to request
        $request->setData('USER1', $order->getStoreId());
        $request->setData('USER2', $this->_getSecureSilentPostHash($payment));

        return $request;
    }

_generateSecureSilentPostHash()

_generateSecureSilentPostHash (   $payment )

protected

Generate end return new secure hash value

Parameters

\Magento\Sales\Model\Order\Payment

$payment

Returns

string

Definition at line 559 of file Payflowlink.php.

    {
        $secureHash = md5($this->mathRandom->getRandomString(10));
        $payment->setAdditionalInformation($this->_secureSilentPostHashKey, $secureHash);
        return $secureHash;
    }

_getOrderFromResponse()

_getOrderFromResponse ( )

protected

Check response from Payflow gateway.

Returns

false|\Magento\Sales\Model\Order in case of validation passed

Exceptions

Definition at line 374 of file Payflowlink.php.

    {
        $response = $this->getResponse();
        $order = $this->_orderFactory->create()->loadByIncrementId($response->getInvnum());

        if ($this->_getSecureSilentPostHash(
            $order->getPayment()
        ) != $response->getData('user2') || $this->_code != $order->getPayment()->getMethodInstance()->getCode()
        ) {
            return false;
        }

        if ($response->getResult() != self::RESPONSE_CODE_FRAUDSERVICE_FILTER &&
            $response->getResult() != self::RESPONSE_CODE_DECLINED_BY_FILTER &&
            $response->getResult() != self::RESPONSE_CODE_APPROVED
        ) {
            if ($order->getState() != \Magento\Sales\Model\Order::STATE_CANCELED) {
                $order->registerCancellation($response->getRespmsg())->save();
            }
            throw new \Magento\Framework\Exception\LocalizedException(__($response->getRespmsg()));
        }

        $amountCompared = $response->getAmt() == $order->getPayment()->getBaseAmountAuthorized() ? true : false;
        if (!$order->getId() ||
            $order->getState() != \Magento\Sales\Model\Order::STATE_PENDING_PAYMENT ||
            !$amountCompared
        ) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('Payment error. %value was not found.', ['value' => 'Order'])
            );
        }

        $fetchData = $this->fetchTransactionInfo($order->getPayment(), $response->getPnref());
        if (!isset($fetchData['custref']) || $fetchData['custref'] != $order->getIncrementId()) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('Payment error. %value was not found.', ['value' => 'Transaction'])
            );
        }

        return $order;
    }

_getSecureSilentPostHash()

_getSecureSilentPostHash (   $payment )

protected

Return secure hash value for silent post request

Parameters

\Magento\Sales\Model\Order\Payment

$payment

Returns

string

Definition at line 548 of file Payflowlink.php.

    {
        return $payment->getAdditionalInformation($this->_secureSilentPostHashKey);
    }

_getStoreId()

_getStoreId ( )

protected

Get store id from response if exists or default

Returns

int

Definition at line 448 of file Payflowlink.php.

    {
        $response = $this->getResponse();
        if ($response->getData('user1')) {
            return (int)$response->getData('user1');
        }
        return $this->storeManager->getStore($this->getStore())->getId();
    }

_getTrxTokenType()

_getTrxTokenType ( )

protected

Get payment action code

Returns

string

Definition at line 503 of file Payflowlink.php.

    {
        switch ($this->getConfigData('payment_action')) {
            case \Magento\Paypal\Model\Config::PAYMENT_ACTION_AUTH:
                return self::TRXTYPE_AUTH_ONLY;
            case \Magento\Paypal\Model\Config::PAYMENT_ACTION_SALE:
                return self::TRXTYPE_SALE;
            default:
                break;
        }
    }

_processOrder()

_processOrder ( \Magento\Sales\Model\Order  $order )

protected

Operate with order using information from silent post

Parameters

\Magento\Sales\Model\Order

$order

Returns

void

Exceptions

Definition at line 308 of file Payflowlink.php.

    {
        $response = $this->getResponse();
        $payment = $order->getPayment();
        $payment->setTransactionId($response->getPnref())->setIsTransactionClosed(0);
        $payment->setCcType($response->getData(OrderPaymentInterface::CC_TYPE));

        $canSendNewOrderEmail = true;
        if ($response->getResult() == self::RESPONSE_CODE_FRAUDSERVICE_FILTER ||
            $response->getResult() == self::RESPONSE_CODE_DECLINED_BY_FILTER
        ) {
            $canSendNewOrderEmail = false;

            $payment->setIsTransactionPending(true)
                ->setIsFraudDetected(true);

            $fraudMessage = $response->getData('respmsg');
            if ($response->getData('fps_prexmldata')) {
                $xml = new \SimpleXMLElement($response->getData('fps_prexmldata'));
                $fraudMessage = (string)$xml->rule->triggeredMessage;
            }
            $payment->setAdditionalInformation(
                Info::PAYPAL_FRAUD_FILTERS,
                $fraudMessage
            );
        }

        if ($response->getData('avsdata') && strstr(substr($response->getData('avsdata'), 0, 2), 'N')) {
            $payment->setAdditionalInformation(Info::PAYPAL_AVS_CODE, substr($response->getData('avsdata'), 0, 2));
        }

        if ($response->getData('cvv2match') && $response->getData('cvv2match') != 'Y') {
            $payment->setAdditionalInformation(Info::PAYPAL_CVV_2_MATCH, $response->getData('cvv2match'));
        }

        switch ($response->getType()) {
            case self::TRXTYPE_AUTH_ONLY:
                $payment->registerAuthorizationNotification($payment->getBaseAmountAuthorized());
                break;
            case self::TRXTYPE_SALE:
                $payment->registerCaptureNotification($payment->getBaseAmountAuthorized());
                break;
            default:
                break;
        }
        $order->save();

        try {
            if ($canSendNewOrderEmail) {
                $this->orderSender->send($order);
            }
            $quote = $this->quoteRepository->get($order->getQuoteId())->setIsActive(false);
            $this->quoteRepository->save($quote);
        } catch (\Exception $e) {
            throw new \Magento\Framework\Exception\LocalizedException(__('We cannot send the new order email.'));
        }
    }

_processTokenErrors()

_processTokenErrors (   $response,   $payment  )

protected

If response is failed throw exception Set token data in payment object

Parameters

\Magento\Framework\DataObject	$response
\Magento\Sales\Model\Order\Payment	$payment

Returns

void

Exceptions

Definition at line 524 of file Payflowlink.php.

    {
        if (!$response->getSecuretoken() &&
            $response->getResult() != self::RESPONSE_CODE_APPROVED &&
            $response->getResult() != self::RESPONSE_CODE_FRAUDSERVICE_FILTER
        ) {
            throw new \Magento\Framework\Exception\LocalizedException(__($response->getRespmsg()));
        } else {
            $payment->setAdditionalInformation(
                'secure_token_id',
                $response->getSecuretokenid()
            )->setAdditionalInformation(
                'secure_token',
                $response->getSecuretoken()
            );
        }
    }

getResponse()

getResponse

(

)

Return response model.

Returns

\Magento\Paypal\Model\Payflow\Request

Definition at line 271 of file Payflowlink.php.

    {
        if (!$this->_response) {
            $this->_response = $this->_requestFactory->create();
        }

        return $this->_response;
    }

isActive()

isActive

(

$storeId = null

)

Is active

Parameters

int | null

$storeId

Returns

bool

Definition at line 225 of file Payflowlink.php.

    {
        return (bool)(int)$this->getConfigData('active', $storeId);
    }

isAvailable()

isAvailable

(

\Magento\Quote\Api\Data\CartInterface

$quote = null

)

Check whether payment method can be used

Parameters

\Magento\Quote\Api\Data\CartInterface | \Magento\Quote\Model\Quote | null

$quote

Returns

bool

Exceptions

Definition at line 214 of file Payflowlink.php.

    {
        return AbstractMethod::isAvailable($quote) && $this->getConfig()->isMethodAvailable($this->getCode());
    }

process()

process

(

$responseData

)

Operate with order using data from $_POST which came from Silent Post Url.

Parameters

array

$responseData

Returns

void

Exceptions

Definition at line 287 of file Payflowlink.php.

    {
        $debugData = ['response' => $responseData];
        $this->_debug($debugData);

        $this->mapGatewayResponse($responseData, $this->getResponse());
        $order = $this->_getOrderFromResponse();
        if ($order) {
            $this->_processOrder($order);
        }
    }

validate()

validate

(

)

Do not validate payment form using server methods

Returns

true

Definition at line 202 of file Payflowlink.php.

    {
        return true;
    }

Field Documentation

$_callbackController

$_callbackController = 'payflow'

protected

Definition at line 32 of file Payflowlink.php.

$_canUseInternal

$_canUseInternal = false

protected

Definition at line 56 of file Payflowlink.php.

$_code

$_code = \Magento\Paypal\Model\Config::METHOD_PAYFLOWLINK

protected

Definition at line 39 of file Payflowlink.php.

$_formBlockType

$_formBlockType = \Magento\Paypal\Block\Payflow\Link\Form::class

protected

Definition at line 44 of file Payflowlink.php.

$_infoBlockType

$_infoBlockType = \Magento\Paypal\Block\Payment\Info::class

protected

Definition at line 49 of file Payflowlink.php.

$_isInitializeNeeded

$_isInitializeNeeded = true

protected

Definition at line 63 of file Payflowlink.php.

$_orderFactory

$_orderFactory

protected

Definition at line 102 of file Payflowlink.php.

$_requestFactory

$_requestFactory

protected

Definition at line 92 of file Payflowlink.php.

$_response

$_response

protected

Definition at line 70 of file Payflowlink.php.

$_secureSilentPostHashKey

$_secureSilentPostHashKey = 'secure_silent_post_hash'

protected

Definition at line 87 of file Payflowlink.php.

$_websiteFactory

$_websiteFactory

protected

Definition at line 107 of file Payflowlink.php.

$orderSender

$orderSender

protected

Definition at line 112 of file Payflowlink.php.

$quoteRepository

$quoteRepository

protected

Definition at line 97 of file Payflowlink.php.

LAYOUT_TEMPLATE

const LAYOUT_TEMPLATE = 'mobile'

Default layout template

Definition at line 25 of file Payflowlink.php.

RESPONSE_ERROR_MSG

const RESPONSE_ERROR_MSG = 'Payment error. %s was not found.'

Error message

Definition at line 80 of file Payflowlink.php.

TRANSACTION_PAYFLOW_URL

const TRANSACTION_PAYFLOW_URL = 'https://payflowlink.paypal.com/'

Gateway request URL

Definition at line 75 of file Payflowlink.php.

---

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

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