Inheritance diagram for Directpost:

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\Authorizenet\Helper\Data $dataHelper, \Magento\Authorizenet\Model\Directpost\Request\Factory $requestFactory, \Magento\Authorizenet\Model\Directpost\Response\Factory $responseFactory, \Magento\Authorizenet\Model\TransactionService $transactionService, \Magento\Framework\HTTP\ZendClientFactory $httpClientFactory, \Magento\Sales\Model\OrderFactory $orderFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Quote\Api\CartRepositoryInterface $quoteRepository, \Magento\Sales\Model\Order\Email\Sender\OrderSender $orderSender, \Magento\Sales\Api\TransactionRepositoryInterface $transactionRepository, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], \Magento\Sales\Api\PaymentFailuresInterface $paymentFailures=null)

	setDataHelper (\Magento\Authorizenet\Helper\Data $dataHelper)

	validate ()

	authorize (\Magento\Payment\Model\InfoInterface $payment, $amount)

	capture (\Magento\Payment\Model\InfoInterface $payment, $amount)

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

	refund (\Magento\Payment\Model\InfoInterface $payment, $amount)

	getCgiUrl ()

	getRelayUrl ($storeId=null)

	getResponse ()

	initialize ($paymentAction, $stateObject)

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

	setResponseData (array $postData)

	validateResponse ()

	process (array $responseData)

	checkResponseCode ()

	checkTransId ()

	getConfigInterface ()

	getValue ($key, $storeId=null)

	setIsInitializeNeeded ($isInitializeNeeded=true)

	canCapture ()

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

	setMethodCode ($methodCode)

	setPathPattern ($pathPattern)

Public Member Functions inherited from Authorizenet
	__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\Authorizenet\Helper\Data $dataHelper, \Magento\Authorizenet\Model\Request\Factory $requestFactory, \Magento\Authorizenet\Model\Response\Factory $responseFactory, TransactionService $transactionService, ZendClientFactory $httpClientFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	canUseForCurrency ($currencyCode)

	getAcceptedCurrencyCodes ()

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

	fetchTransactionFraudDetails ($transactionId)

Public Member Functions inherited from MethodInterface
	getCode ()

	getFormBlockType ()

	getTitle ()

	setStore ($storeId)

	getStore ()

	canOrder ()

	canAuthorize ()

	canCapturePartial ()

	canCaptureOnce ()

	canRefund ()

	canRefundPartialPerInvoice ()

	canVoid ()

	canUseInternal ()

	canUseCheckout ()

	canEdit ()

	canFetchTransactionInfo ()

	fetchTransactionInfo (InfoInterface $payment, $transactionId)

	isGateway ()

	isOffline ()

	isInitializeNeeded ()

	canUseForCountry ($country)

	canUseForCurrency ($currencyCode)

	getInfoBlockType ()

	getInfoInstance ()

	setInfoInstance (InfoInterface $info)

	order (\Magento\Payment\Model\InfoInterface $payment, $amount)

	authorize (\Magento\Payment\Model\InfoInterface $payment, $amount)

	capture (\Magento\Payment\Model\InfoInterface $payment, $amount)

	refund (\Magento\Payment\Model\InfoInterface $payment, $amount)

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

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

	canReviewPayment ()

	acceptPayment (InfoInterface $payment)

	denyPayment (InfoInterface $payment)

	getConfigData ($field, $storeId=null)

	assignData (DataObject $data)

	isAvailable (CartInterface $quote=null)

	isActive ($storeId=null)

	getConfigPaymentAction ()

Data Fields
const	METHOD_CODE = 'authorizenet_directpost'

Data Fields inherited from Authorizenet
const	CGI_URL = 'https://secure.authorize.net/gateway/transact.dll'

const	REQUEST_METHOD_CC = 'CC'

const	REQUEST_TYPE_AUTH_CAPTURE = 'AUTH_CAPTURE'

const	REQUEST_TYPE_AUTH_ONLY = 'AUTH_ONLY'

const	REQUEST_TYPE_CAPTURE_ONLY = 'CAPTURE_ONLY'

const	REQUEST_TYPE_CREDIT = 'CREDIT'

const	REQUEST_TYPE_VOID = 'VOID'

const	REQUEST_TYPE_PRIOR_AUTH_CAPTURE = 'PRIOR_AUTH_CAPTURE'

const	RESPONSE_DELIM_CHAR = '(~)'

const	RESPONSE_CODE_APPROVED = 1

const	RESPONSE_CODE_DECLINED = 2

const	RESPONSE_CODE_ERROR = 3

const	RESPONSE_CODE_HELD = 4

const	RESPONSE_REASON_CODE_APPROVED = 1

const	RESPONSE_REASON_CODE_PENDING_REVIEW_AUTHORIZED = 252

const	RESPONSE_REASON_CODE_PENDING_REVIEW = 253

const	RESPONSE_REASON_CODE_PENDING_REVIEW_DECLINED = 254

const	TRANSACTION_FRAUD_STATE_KEY = 'is_transaction_fraud'

const	REAL_TRANSACTION_ID_KEY = 'real_transaction_id'

const	GATEWAY_ACTIONS_LOCKED_STATE_KEY = 'is_gateway_actions_locked'

Data Fields inherited from MethodInterface
const	ACTION_ORDER = 'order'

const	ACTION_AUTHORIZE = 'authorize'

const	ACTION_AUTHORIZE_CAPTURE = 'authorize_capture'

const	CHECK_USE_FOR_COUNTRY = 'country'

const	CHECK_USE_FOR_CURRENCY = 'currency'

const	CHECK_USE_CHECKOUT = 'checkout'

const	CHECK_USE_INTERNAL = 'internal'

const	CHECK_ORDER_TOTAL_MIN_MAX = 'total'

const	CHECK_ZERO_TOTAL = 'zero_total'

const	GROUP_OFFLINE = 'offline'

Protected Member Functions
	processCapture ($result, $payment)

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

	fillPaymentByResponse (\Magento\Framework\DataObject $payment)

	matchAmount ($amount)

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

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

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

	declineOrder (\Magento\Sales\Model\Order $order, $message='', $voidPayment=true)

	getRealParentTransactionId ($payment)

	addStatusCommentOnUpdate (\Magento\Sales\Model\Order\Payment $payment, \Magento\Framework\DataObject $response, $transactionId)

	getTransactionResponse ($transactionId)

Protected Member Functions inherited from Authorizenet
	getFraudFilters ($fraudFilters)

	getRequest ()

	isGatewayActionsLocked ($payment)

Protected Attributes
	$_formBlockType = \Magento\Payment\Block\Transparent\Info::class

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

	$_isGateway = true

	$_canAuthorize = true

	$_canCapture = true

	$_canRefund = true

	$_canRefundInvoicePartial = true

	$_canVoid = true

	$_canFetchTransactionInfo = true

	$_isInitializeNeeded = true

	$storeManager

	$quoteRepository

	$response

	$orderSender

	$orderFactory

	$transactionRepository

Protected Attributes inherited from Authorizenet
	$dataHelper

	$requestFactory

	$responseFactory

	$transactionService

	$_debugReplacePrivateDataKeys = ['merchantAuthentication', 'x_login']

	$httpClientFactory

Detailed Description

Authorize.net DirectPost payment method model. @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.ExcessiveClassComplexity)

Definition at line 18 of file Directpost.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\Authorizenet\Helper\Data	$dataHelper,
		\Magento\Authorizenet\Model\Directpost\Request\Factory	$requestFactory,
		\Magento\Authorizenet\Model\Directpost\Response\Factory	$responseFactory,
		\Magento\Authorizenet\Model\TransactionService	$transactionService,
		\Magento\Framework\HTTP\ZendClientFactory	$httpClientFactory,
		\Magento\Sales\Model\OrderFactory	$orderFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository,
		\Magento\Sales\Model\Order\Email\Sender\OrderSender	$orderSender,
		\Magento\Sales\Api\TransactionRepositoryInterface	$transactionRepository,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`,
		\Magento\Sales\Api\PaymentFailuresInterface	$paymentFailures = `null`
	)

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\Authorizenet\Helper\Data	$dataHelper
\Magento\Authorizenet\Model\Directpost\Request\Factory	$requestFactory
\Magento\Authorizenet\Model\Directpost\Response\Factory	$responseFactory
\Magento\Authorizenet\Model\TransactionService	$transactionService
\Magento\Framework\HTTP\ZendClientFactory	$httpClientFactory
\Magento\Sales\Model\OrderFactory	$orderFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository
\Magento\Sales\Model\Order\Email\Sender\OrderSender	$orderSender
\Magento\Sales\Api\TransactionRepositoryInterface	$transactionRepository
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data
\Magento\Sales\Api\PaymentFailuresInterface \| null	$paymentFailures	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 161 of file Directpost.php.

       {
         $this->orderFactory = $orderFactory;
         $this->storeManager = $storeManager;
         $this->quoteRepository = $quoteRepository;
         $this->response = $responseFactory->create();
         $this->orderSender = $orderSender;
         $this->transactionRepository = $transactionRepository;
         $this->_code = static::METHOD_CODE;
         $this->paymentFailures = $paymentFailures ? : ObjectManager::getInstance()
             ->get(\Magento\Sales\Api\PaymentFailuresInterface::class);
 
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $paymentData,
             $scopeConfig,
             $logger,
             $moduleList,
             $localeDate,
             $dataHelper,
             $requestFactory,
             $responseFactory,
             $transactionService,
             $httpClientFactory,
             $resource,
             $resourceCollection,
             $data
         );
     }

Member Function Documentation

◆ addStatusComment()

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

protected

Add status comment

Parameters

\Magento\Sales\Model\Order\Payment $payment

Returns: $this

Definition at line 777 of file Directpost.php.

     {
         try {
             $transactionId = $this->getResponse()->getXTransId();
             $data = $this->transactionService->getTransactionDetails($this, $transactionId);
             $transactionStatus = (string)$data->transaction->transactionStatus;
             $fdsFilterAction = (string)$data->transaction->FDSFilterAction;
 
             if ($payment->getIsTransactionPending()) {
                 $message = 'Amount of %1 is pending approval on the gateway.<br/>'
                     . 'Transaction "%2" status is "%3".<br/>'
                     . 'Transaction FDS Filter Action is "%4"';
                 $message = __(
                     $message,
                     $payment->getOrder()->getBaseCurrency()->formatTxt($this->getResponse()->getXAmount()),
                     $transactionId,
                     $this->dataHelper->getTransactionStatusLabel($transactionStatus),
                     $this->dataHelper->getFdsFilterActionLabel($fdsFilterAction)
                 );
                 $payment->getOrder()->addStatusHistoryComment($message);
             }
         } catch (\Exception $e) {
             $this->getPsrLogger()->critical($e);
             //this request is optional
         }
         return $this;
     }

◆ addStatusCommentOnUpdate()

addStatusCommentOnUpdate	(	\Magento\Sales\Model\Order\Payment	$payment,
		\Magento\Framework\DataObject	$response,
			$transactionId
	)

protected

Parameters

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

Returns: $this

Definition at line 930 of file Directpost.php.

       {
         if ($payment->getIsTransactionApproved()) {
             $message = __(
                 'Transaction %1 has been approved. Amount %2. Transaction status is "%3"',
                 $transactionId,
                 $payment->getOrder()->getBaseCurrency()->formatTxt($payment->getAmountAuthorized()),
                 $this->dataHelper->getTransactionStatusLabel($response->getTransactionStatus())
             );
             $payment->getOrder()->addStatusHistoryComment($message);
         } elseif ($payment->getIsTransactionDenied()) {
             $message = __(
                 'Transaction %1 has been voided/declined. Transaction status is "%2". Amount %3.',
                 $transactionId,
                 $this->dataHelper->getTransactionStatusLabel($response->getTransactionStatus()),
                 $payment->getOrder()->getBaseCurrency()->formatTxt($payment->getAmountAuthorized())
             );
             $payment->getOrder()->addStatusHistoryComment($message);
         }
         return $this;
     }

◆ authorize()

authorize	(	\Magento\Payment\Model\InfoInterface	$payment,
			$amount
	)

Send authorize request to gateway

Parameters

\Magento\Framework\DataObject \| \Magento\Payment\Model\InfoInterface	$payment
float	$amount

Returns: void @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 246 of file Directpost.php.

     {
         $payment->setAdditionalInformation('payment_type', $this->getConfigData('payment_action'));
     }

◆ canCapture()

canCapture ( )

Get whether it is possible to capture

Returns: bool

Implements MethodInterface.

Definition at line 885 of file Directpost.php.

     {
         return !$this->isGatewayActionsLocked($this->getInfoInstance());
     }

◆ capture()

capture	(	\Magento\Payment\Model\InfoInterface	$payment,
			$amount
	)

Send capture request to gateway

Parameters

\Magento\Framework\DataObject \| \Magento\Payment\Model\InfoInterface	$payment
float	$amount

Returns: $this

Exceptions

Definition at line 259 of file Directpost.php.

     {
         if ($amount <= 0) {
             throw new \Magento\Framework\Exception\LocalizedException(__('Invalid amount for capture.'));
         }
 
         $payment->setAmount($amount);
 
         if ($payment->getParentTransactionId()) {
             $payment->setAnetTransType(self::REQUEST_TYPE_PRIOR_AUTH_CAPTURE);
             $payment->setXTransId($this->getRealParentTransactionId($payment));
         } else {
             $payment->setAnetTransType(self::REQUEST_TYPE_AUTH_CAPTURE);
         }
 
         $result = $this->getResponse();
         if (empty($result->getData())) {
             $request = $this->buildRequest($payment);
             $result = $this->postRequest($request);
         }
 
         return $this->processCapture($result, $payment);
     }

◆ checkResponseCode()

checkResponseCode ( )

Check response code came from Authorize.net.

Returns: true in case of Approved response

Exceptions

Definition at line 637 of file Directpost.php.

     {
         switch ($this->getResponse()->getXResponseCode()) {
             case self::RESPONSE_CODE_APPROVED:
             case self::RESPONSE_CODE_HELD:
                 return true;
             case self::RESPONSE_CODE_DECLINED:
             case self::RESPONSE_CODE_ERROR:
                 $errorMessage = $this->dataHelper->wrapGatewayError($this->getResponse()->getXResponseReasonText());
                 $order = $this->getOrderFromResponse();
                 $this->paymentFailures->handle((int)$order->getQuoteId(), $errorMessage);
                 throw new \Magento\Framework\Exception\LocalizedException($errorMessage);
             default:
                 throw new \Magento\Framework\Exception\LocalizedException(
                     __('There was a payment authorization error.')
                 );
         }
     }

◆ checkTransId()

checkTransId ( )

Check transaction id came from Authorize.net

Returns: true in case of right transaction id

Exceptions

Definition at line 662 of file Directpost.php.

     {
         if (!$this->getResponse()->getXTransId()) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('Please enter a transaction ID to authorize this payment.')
             );
         }
         return true;
     }

◆ declineOrder()

declineOrder	(	\Magento\Sales\Model\Order	$order,
			$message = `''`,
			$voidPayment = `true`
	)

protected

Register order cancellation. Return money to customer if needed.

Parameters

\Magento\Sales\Model\Order	$order
string	$message
bool	$voidPayment

Returns: void

Definition at line 813 of file Directpost.php.

     {
         try {
             $response = $this->getResponse();
             if ($voidPayment
                 && $response->getXTransId()
                 && strtoupper($response->getXType()) == self::REQUEST_TYPE_AUTH_ONLY
             ) {
                 $order->getPayment()
                       ->setTransactionId(null)
                       ->setParentTransactionId($response->getXTransId())
                       ->void($response);
             }
             $order->registerCancellation($message)->save();
         } catch (\Exception $e) {
             //quiet decline
             $this->getPsrLogger()->critical($e);
         }
     }

◆ fetchTransactionInfo()

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

Fetch transaction details info

Update transaction info if there is one placing transaction only

Parameters

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

Returns: array

Definition at line 899 of file Directpost.php.

     {
         $transaction = $this->transactionRepository->getByTransactionId(
             $transactionId,
             $payment->getId(),
             $payment->getOrder()->getId()
         );
 
         $response = $this->getTransactionResponse($transactionId);
         if ($response->getXResponseCode() == self::RESPONSE_CODE_APPROVED) {
             if ($response->getTransactionStatus() == 'voided') {
                 $payment->setIsTransactionDenied(true);
                 $payment->setIsTransactionClosed(true);
                 $transaction->close();
             } else {
                 $transaction->setAdditionalInformation(self::TRANSACTION_FRAUD_STATE_KEY, false);
                 $payment->setIsTransactionApproved(true);
             }
         } elseif ($response->getXResponseReasonCode() == self::RESPONSE_REASON_CODE_PENDING_REVIEW_DECLINED) {
             $payment->setIsTransactionDenied(true);
         }
         $this->addStatusCommentOnUpdate($payment, $response, $transactionId);
         return [];
     }

◆ fillPaymentByResponse()

fillPaymentByResponse ( \Magento\Framework\DataObject $payment )

protected

Fill payment with credit card data from response from Authorize.net.

Parameters

\Magento\Framework\DataObject $payment

Returns: void

Definition at line 612 of file Directpost.php.

     {
         $response = $this->getResponse();
         $payment->setTransactionId($response->getXTransId())
             ->setParentTransactionId(null)
             ->setIsTransactionClosed(0)
             ->setTransactionAdditionalInfo(self::REAL_TRANSACTION_ID_KEY, $response->getXTransId());
 
         if ($response->getXMethod() == self::REQUEST_METHOD_CC) {
             $payment->setCcAvsStatus($response->getXAvsCode())
                 ->setCcLast4($payment->encrypt(substr($response->getXAccountNumber(), -4)));
         }
 
         if ($response->getXResponseCode() == self::RESPONSE_CODE_HELD) {
             $payment->setIsTransactionPending(true)
                 ->setIsFraudDetected(true);
         }
     }

◆ generateRequestFromOrder()

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

Generate request object and fill its fields from Quote or Order object

Parameters

\Magento\Sales\Model\Order $order Quote or order object.

Returns: \Magento\Authorizenet\Model\Directpost\Request

Definition at line 514 of file Directpost.php.

     {
         $request = $this->requestFactory->create()
             ->setConstantData($this)
             ->setDataFromOrder($order, $this)
             ->signRequestData();
 
         $this->_debug(['request' => $request->getData()]);
 
         return $request;
     }

◆ getCgiUrl()

getCgiUrl ( )

Get CGI url

Returns: string

Definition at line 449 of file Directpost.php.

     {
         $uri = $this->getConfigData('cgi_url');
         return $uri ? $uri : self::CGI_URL;
     }

◆ getConfigInterface()

getConfigInterface ( )

{inheritdoc}

Implements TransparentInterface.

Definition at line 852 of file Directpost.php.

     {
         return $this;
     }

◆ getRealParentTransactionId()

getRealParentTransactionId ( $payment )

protected

Return additional information`s transaction_id value of parent transaction model

Parameters

\Magento\Sales\Model\Order\Payment $payment

Returns: string

Definition at line 839 of file Directpost.php.

     {
         $transaction = $this->transactionRepository->getByTransactionId(
             $payment->getParentTransactionId(),
             $payment->getId(),
             $payment->getOrder()->getId()
         );
         return $transaction->getAdditionalInformation(self::REAL_TRANSACTION_ID_KEY);
     }

◆ getRelayUrl()

getRelayUrl ( $storeId = null )

Return URL on which Authorize.net server will return payment result data in hidden request.

Parameters

int $storeId

Returns: string

Definition at line 461 of file Directpost.php.

     {
         if ($storeId == null && $this->getStore()) {
             $storeId = $this->getStore();
         }
         return $this->dataHelper->getRelayUrl($storeId);
     }

◆ getResponse()

getResponse ( )

Return response.

Returns: \Magento\Authorizenet\Model\Directpost\Response

Definition at line 474 of file Directpost.php.

     {
         return $this->response;
     }

◆ getTransactionResponse()

getTransactionResponse ( $transactionId )

protected

This function returns full transaction details for a specified transaction ID.

Parameters

string $transactionId

Returns: \Magento\Framework\DataObject

Exceptions

Definition at line 986 of file Directpost.php.

     {
         $responseXmlDocument = $this->transactionService->getTransactionDetails($this, $transactionId);
 
         $response = new \Magento\Framework\DataObject();
         $response->setXResponseCode((string)$responseXmlDocument->transaction->responseCode)
             ->setXResponseReasonCode((string)$responseXmlDocument->transaction->responseReasonCode)
             ->setTransactionStatus((string)$responseXmlDocument->transaction->transactionStatus);
 
         return $response;
     }

◆ getValue()

getValue	(	$key,
		$storeId = `null`
	)

Getter for specified value according to set payment method code

Parameters

mixed	$key
null	$storeId

Returns: mixed

Implements ConfigInterface.

Definition at line 864 of file Directpost.php.

     {
         return $this->getConfigData($key, $storeId);
     }

◆ initialize()

initialize	(	$paymentAction,
		$stateObject
	)

Instantiate state and set it to state object

Parameters

string	$paymentAction
\Magento\Framework\DataObject	$stateObject

Returns: void @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements MethodInterface.

Definition at line 487 of file Directpost.php.

     {
         $requestType = null;
         switch ($paymentAction) {
             case self::ACTION_AUTHORIZE:
                 $requestType = self::REQUEST_TYPE_AUTH_ONLY;
                 //intentional
             case self::ACTION_AUTHORIZE_CAPTURE:
                 $requestType = $requestType ?: self::REQUEST_TYPE_AUTH_CAPTURE;
                 $payment = $this->getInfoInstance();
                 $order = $payment->getOrder();
                 $order->setCanSendNewEmailFlag(false);
                 $payment->setBaseAmountAuthorized($order->getBaseTotalDue());
                 $payment->setAmountAuthorized($order->getTotalDue());
                 $payment->setAnetTransType($requestType);
                 break;
             default:
                 break;
         }
     }

◆ matchAmount()

matchAmount ( $amount )

protected

Compare amount with amount from the response from Authorize.net.

Parameters

float $amount

Returns: bool

Definition at line 678 of file Directpost.php.

     {
         return sprintf('%.2F', $amount) == sprintf('%.2F', $this->getResponse()->getXAmount());
     }

◆ process()

process ( array $responseData )

Operate with order using data from $_POST which came from authorize.net by Relay URL.

Parameters

array $responseData data from Authorize.net from $_POST

Returns: void

Exceptions

Definition at line 566 of file Directpost.php.

     {
         $this->_debug(['response' => $responseData]);
 
         $this->setResponseData($responseData);
 
         //check MD5 error or others response errors
         //throws exception on false.
         $this->validateResponse();
 
         $response = $this->getResponse();
         $responseText = $this->dataHelper->wrapGatewayError($response->getXResponseReasonText());
         $isError = false;
         if ($this->getOrderIncrementId()) {
             $order = $this->getOrderFromResponse();
             //check payment method
             $payment = $order->getPayment();
             if (!$payment || $payment->getMethod() != $this->getCode()) {
                 throw new \Magento\Framework\Exception\LocalizedException(
                     __('This payment didn\'t work out because we can\'t find this order.')
                 );
             }
             if ($order->getId()) {
                 //operate with order
                 $this->processOrder($order);
             } else {
                 $isError = true;
             }
         } else {
             $isError = true;
         }
 
         if ($isError) {
             $responseText = $responseText && !$response->isApproved()
                 ? $responseText
                 : __('This payment didn\'t work out because we can\'t find this order.');
             throw new \Magento\Framework\Exception\LocalizedException($responseText);
         }
     }

◆ processCapture()

processCapture	(	$result,
		$payment
	)

protected

Process capture request

Parameters

\Magento\Authorizenet\Model\Directpost\Response	$result
\Magento\Payment\Model\InfoInterface	$payment

Returns: $this

Exceptions

Definition at line 291 of file Directpost.php.

     {
         switch ($result->getXResponseCode()) {
             case self::RESPONSE_CODE_APPROVED:
             case self::RESPONSE_CODE_HELD:
                 if (in_array(
                     $result->getXResponseReasonCode(),
                     [
                             self::RESPONSE_REASON_CODE_APPROVED,
                             self::RESPONSE_REASON_CODE_PENDING_REVIEW,
                             self::RESPONSE_REASON_CODE_PENDING_REVIEW_AUTHORIZED
                         ]
                 )
                 ) {
                     if (!$payment->getParentTransactionId()
                         || $result->getXTransId() != $payment->getParentTransactionId()
                     ) {
                         $payment->setTransactionId($result->getXTransId());
                     }
                     $payment->setIsTransactionClosed(0)
                         ->setTransactionAdditionalInfo(
                             self::REAL_TRANSACTION_ID_KEY,
                             $result->getXTransId()
                         );
                     return $this;
                 }
                 throw new \Magento\Framework\Exception\LocalizedException(
                     $this->dataHelper->wrapGatewayError($result->getXResponseReasonText())
                 );
             case self::RESPONSE_CODE_DECLINED:
             case self::RESPONSE_CODE_ERROR:
                 throw new \Magento\Framework\Exception\LocalizedException(
                     $this->dataHelper->wrapGatewayError($result->getXResponseReasonText())
                 );
             default:
                 throw new \Magento\Framework\Exception\LocalizedException(__('Payment capturing error.'));
         }
     }

◆ processOrder()

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

protected

Operate with order using information from Authorize.net. Authorize order or authorize and capture it.

Parameters

\Magento\Sales\Model\Order $order

Returns: void

Exceptions

Definition at line 693 of file Directpost.php.

     {
         try {
             $this->checkResponseCode();
             $this->checkTransId();
         } catch (\Exception $e) {
             //decline the order (in case of wrong response code) but don't return money to customer.
             $message = $e->getMessage();
             $this->declineOrder($order, $message, false);
             throw $e;
         }
 
         $response = $this->getResponse();
 
         //create transaction. need for void if amount will not match.
         $payment = $order->getPayment();
         $this->fillPaymentByResponse($payment);
         $payment->getMethodInstance()->setIsInitializeNeeded(false);
         $payment->getMethodInstance()->setResponseData($response->getData());
         $this->processPaymentFraudStatus($payment);
         $payment->place();
         $this->addStatusComment($payment);
         $order->save();
 
         //match amounts. should be equals for authorization.
         //decline the order if amount does not match.
         if (!$this->matchAmount($payment->getBaseAmountAuthorized())) {
             $message = __(
                 'Something went wrong: the paid amount doesn\'t match the order amount.'
                 . ' Please correct this and try again.'
             );
             $this->declineOrder($order, $message, true);
             throw new \Magento\Framework\Exception\LocalizedException($message);
         }
 
         try {
             if (!$response->hasOrderSendConfirmation() || $response->getOrderSendConfirmation()) {
                 $this->orderSender->send($order);
             }
 
             $quote = $this->quoteRepository->get($order->getQuoteId())->setIsActive(false);
             $this->quoteRepository->save($quote);
         } catch (\Exception $e) {
             // do not cancel order if we couldn't send email
         }
     }

◆ processPaymentFraudStatus()

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

protected

Process fraud status

Parameters

\Magento\Sales\Model\Order\Payment $payment

Returns: $this

Definition at line 746 of file Directpost.php.

     {
         try {
             $fraudDetailsResponse = $payment->getMethodInstance()
                 ->fetchTransactionFraudDetails($this->getResponse()->getXTransId());
             $fraudData = $fraudDetailsResponse->getData();
 
             if (empty($fraudData)) {
                 $payment->setIsFraudDetected(false);
                 return $this;
             }
 
             $fdsFilterAction = (string)$fraudDetailsResponse->getFdsFilterAction();
             if ($this->fdsFilterActionIsReportOnly($fdsFilterAction) === false) {
                 $payment->setIsFraudDetected(true);
             }
 
             $payment->setAdditionalInformation('fraud_details', $fraudData);
         } catch (\Exception $e) {
             //this request is optional
         }
 
         return $this;
     }

◆ processRefund()

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

protected

Refund the amount with transaction id

Parameters

\Magento\Framework\DataObject	$payment
float	$amount

Returns: $this

Exceptions

Definition at line 404 of file Directpost.php.

     {
         if ($amount <= 0) {
             throw new \Magento\Framework\Exception\LocalizedException(__('Invalid amount for refund.'));
         }
 
         if (!$payment->getParentTransactionId()) {
             throw new \Magento\Framework\Exception\LocalizedException(__('Invalid transaction ID.'));
         }
 
         $payment->setAnetTransType(self::REQUEST_TYPE_CREDIT);
         $payment->setAmount($amount);
         $payment->setXTransId($this->getRealParentTransactionId($payment));
 
         $request = $this->buildRequest($payment);
         $result = $this->postRequest($request);
 
         switch ($result->getXResponseCode()) {
             case self::RESPONSE_CODE_APPROVED:
                 if ($result->getXResponseReasonCode() == self::RESPONSE_REASON_CODE_APPROVED) {
                     if ($result->getXTransId() != $payment->getParentTransactionId()) {
                         $payment->setTransactionId($result->getXTransId());
                     }
                     $payment->setIsTransactionClosed(true)
                         ->setTransactionAdditionalInfo(self::REAL_TRANSACTION_ID_KEY, $result->getXTransId());
                     return $this;
                 }
                 throw new \Magento\Framework\Exception\LocalizedException(
                     $this->dataHelper->wrapGatewayError($result->getXResponseReasonText())
                 );
             case self::RESPONSE_CODE_DECLINED:
             case self::RESPONSE_CODE_ERROR:
                 throw new \Magento\Framework\Exception\LocalizedException(
                     $this->dataHelper->wrapGatewayError($result->getXResponseReasonText())
                 );
             default:
                 throw new \Magento\Framework\Exception\LocalizedException(__('Payment refunding error.'));
         }
     }

◆ refund()

refund	(	\Magento\Payment\Model\InfoInterface	$payment,
			$amount
	)

Refund the amount Need to decode last 4 digits for request.

Parameters

\Magento\Framework\DataObject \| \Magento\Payment\Model\InfoInterface	$payment
float	$amount

Returns: $this

Exceptions

Definition at line 382 of file Directpost.php.

     {
         $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;
     }

◆ setDataHelper()

setDataHelper ( \Magento\Authorizenet\Helper\Data $dataHelper )

Set data helper

Parameters

\Magento\Authorizenet\Helper\Data $dataHelper

Returns: void

Definition at line 223 of file Directpost.php.

     {
         $this->dataHelper = $dataHelper;
     }

◆ setIsInitializeNeeded()

setIsInitializeNeeded ( $isInitializeNeeded = true )

Set initialization requirement state

Parameters

bool $isInitializeNeeded

Returns: void

Definition at line 875 of file Directpost.php.

     {
         $this->_isInitializeNeeded = (bool)$isInitializeNeeded;
     }

◆ setMethodCode()

setMethodCode ( $methodCode )

Sets method code

Parameters

string $methodCode @SuppressWarnings(PHPMD.UnusedFormalParameter)

Returns: void

Implements ConfigInterface.

Definition at line 962 of file Directpost.php.

963 {

964 }

◆ setPathPattern()

setPathPattern ( $pathPattern )

Sets path pattern

Parameters

string $pathPattern @SuppressWarnings(PHPMD.UnusedFormalParameter)

Returns: void

Implements ConfigInterface.

Definition at line 973 of file Directpost.php.

974 {

975 }

◆ setResponseData()

setResponseData ( array $postData )

Fill response with data.

Parameters

array $postData

Returns: $this

Definition at line 532 of file Directpost.php.

     {
         $this->getResponse()->setData($postData);
         return $this;
     }

◆ validate()

validate ( )

Do not validate payment form using server methods

Returns: bool

Implements MethodInterface.

Definition at line 233 of file Directpost.php.

     {
         return true;
     }

◆ validateResponse()

validateResponse ( )

Validate response data. Needed in controllers.

Returns: bool true in case of validation success.

Exceptions

Definition at line 544 of file Directpost.php.

     {
         $response = $this->getResponse();
         //md5 check
         if (!$this->getConfigData('trans_md5')
             || !$this->getConfigData('login')
             || !$response->isValidHash($this->getConfigData('trans_md5'), $this->getConfigData('login'))
         ) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('The transaction was declined because the response hash validation failed.')
             );
         }
         return true;
     }

◆ void()

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

Void the payment through gateway

Parameters

\Magento\Framework\DataObject | \Magento\Payment\Model\InfoInterface $payment

Returns: $this

Exceptions

Definition at line 337 of file Directpost.php.

     {
         if (!$payment->getParentTransactionId()) {
             throw new \Magento\Framework\Exception\LocalizedException(__('Invalid transaction ID.'));
         }
 
         $payment->setAnetTransType(self::REQUEST_TYPE_VOID);
         $payment->setXTransId($this->getRealParentTransactionId($payment));
 
         $request = $this->buildRequest($payment);
         $result = $this->postRequest($request);
 
         switch ($result->getXResponseCode()) {
             case self::RESPONSE_CODE_APPROVED:
                 if ($result->getXResponseReasonCode() == self::RESPONSE_REASON_CODE_APPROVED) {
                     if ($result->getXTransId() != $payment->getParentTransactionId()) {
                         $payment->setTransactionId($result->getXTransId());
                     }
                     $payment->setIsTransactionClosed(1)
                         ->setShouldCloseParentTransaction(1)
                         ->setTransactionAdditionalInfo(self::REAL_TRANSACTION_ID_KEY, $result->getXTransId());
                     return $this;
                 }
                 throw new \Magento\Framework\Exception\LocalizedException(
                     $this->dataHelper->wrapGatewayError($result->getXResponseReasonText())
                 );
             case self::RESPONSE_CODE_DECLINED:
             case self::RESPONSE_CODE_ERROR:
                 throw new \Magento\Framework\Exception\LocalizedException(
                     $this->dataHelper->wrapGatewayError($result->getXResponseReasonText())
                 );
             default:
                 throw new \Magento\Framework\Exception\LocalizedException(__('Payment voiding error.'));
         }
     }

Field Documentation

◆ $_canAuthorize

$_canAuthorize = true

protected

Definition at line 44 of file Directpost.php.

◆ $_canCapture

$_canCapture = true

protected

Definition at line 51 of file Directpost.php.

◆ $_canFetchTransactionInfo

$_canFetchTransactionInfo = true

protected

Definition at line 79 of file Directpost.php.

◆ $_canRefund

$_canRefund = true

protected

Definition at line 58 of file Directpost.php.

◆ $_canRefundInvoicePartial

$_canRefundInvoicePartial = true

protected

Definition at line 65 of file Directpost.php.

◆ $_canVoid

$_canVoid = true

protected

Definition at line 72 of file Directpost.php.

◆ $_formBlockType

$_formBlockType = \Magento\Payment\Block\Transparent\Info::class

protected

Definition at line 25 of file Directpost.php.

◆ $_infoBlockType

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

protected

Definition at line 30 of file Directpost.php.

◆ $_isGateway

$_isGateway = true

protected

Definition at line 37 of file Directpost.php.

◆ $_isInitializeNeeded

$_isInitializeNeeded = true

protected

Definition at line 86 of file Directpost.php.

◆ $orderFactory

$orderFactory

protected

Definition at line 113 of file Directpost.php.

◆ $orderSender

$orderSender

protected

Definition at line 106 of file Directpost.php.

◆ $quoteRepository

$quoteRepository

protected

Definition at line 96 of file Directpost.php.

◆ $response

$response

protected

Definition at line 101 of file Directpost.php.

◆ $storeManager

$storeManager

protected

Definition at line 91 of file Directpost.php.

◆ $transactionRepository

$transactionRepository

protected

Definition at line 118 of file Directpost.php.

◆ METHOD_CODE

const METHOD_CODE = 'authorizenet_directpost'

Definition at line 20 of file Directpost.php.

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

vendor/magento/module-authorizenet/Model/Directpost.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addStatusComment()

◆ addStatusCommentOnUpdate()

◆ authorize()

◆ canCapture()

◆ capture()

◆ checkResponseCode()

◆ checkTransId()

◆ declineOrder()

◆ fetchTransactionInfo()

◆ fillPaymentByResponse()

◆ generateRequestFromOrder()

◆ getCgiUrl()

◆ getConfigInterface()

◆ getRealParentTransactionId()

◆ getRelayUrl()

◆ getResponse()

◆ getTransactionResponse()

◆ getValue()

◆ initialize()

◆ matchAmount()

◆ process()

◆ processCapture()

◆ processOrder()

◆ processPaymentFraudStatus()

◆ processRefund()

◆ refund()

◆ setDataHelper()

◆ setIsInitializeNeeded()

◆ setMethodCode()

◆ setPathPattern()

◆ setResponseData()

◆ validate()

◆ validateResponse()

◆ void()

Field Documentation

◆ $_canAuthorize

◆ $_canCapture

◆ $_canFetchTransactionInfo

◆ $_canRefund

◆ $_canRefundInvoicePartial

◆ $_canVoid

◆ $_formBlockType

◆ $_infoBlockType

◆ $_isGateway

◆ $_isInitializeNeeded

◆ $orderFactory

◆ $orderSender

◆ $quoteRepository

◆ $response

◆ $storeManager

◆ $transactionRepository

◆ METHOD_CODE