How is a payment method's authorize() used?

dmitry_fedyuk · February 14, 2016, 7:59am

Declaration

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/MethodInterface.php#L249-L257


/**
 * Authorize payment abstract method
 *
 * @param InfoInterface $payment
 * @param float $amount
 * @return $this
 * 
 */
public function authorize(\Magento\Payment\Model\InfoInterface $payment, $amount);

Definition

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L603-L619


/**
 * Authorize payment abstract method
 *
 * @param \Magento\Framework\DataObject|InfoInterface $payment
 * @param float $amount
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 * @api
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function authorize(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    if (!$this->canAuthorize()) {
        throw new \Magento\Framework\Exception\LocalizedException(__('The authorize action is not available.'));
    }
    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Authorizenet/Model/Directpost.php#L221-L232


/**
 * Send authorize request to gateway
 *
 * @param \Magento\Framework\DataObject|\Magento\Payment\Model\InfoInterface $payment
 * @param  float $amount
 * @return void
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function authorize(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    $payment->setAdditionalInformation('payment_type', $this->getConfigData('payment_action'));
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Braintree/Model/PaymentMethod.php#L306-L317


/**
 * Authorizes specified amount
 *
 * @param InfoInterface $payment
 * @param float $amount
 * @return $this
 * @throws LocalizedException
 */
public function authorize(InfoInterface $payment, $amount)
{
    return $this->braintreeAuthorize($payment, $amount, false);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/Adapter.php#L425-L433


public function authorize(InfoInterface $payment, $amount)
{
    $this->executeCommand(
        'authorize',
        ['payment' => $payment, 'amount' => $amount]
    );


    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Direct.php#L296-L306


/**
 * Authorize payment
 *
 * @param \Magento\Framework\DataObject|\Magento\Payment\Model\InfoInterface|Payment $payment
 * @param float $amount
 * @return $this
 */
public function authorize(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    return $this->_placeOrder($payment, $amount);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Express.php#L436-L446


/**
 * Authorize payment
 *
 * @param \Magento\Framework\DataObject|\Magento\Payment\Model\InfoInterface|Payment $payment
 * @param float $amount
 * @return $this
 */
public function authorize(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    return $this->_placeOrder($payment, $amount);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Payflowpro.php#L359-L377


/**
 * Authorize payment
 *
 * @param InfoInterface|Payment|Object $payment
 * @param float $amount
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 * @throws \Magento\Framework\Exception\State\InvalidTransitionException
 */
public function authorize(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    $request = $this->_buildPlaceRequest($payment, $amount);
    $this->addRequestOrderInfo($request, $payment->getOrder());
    $request->setTrxtype(self::TRXTYPE_AUTH_ONLY);
    $response = $this->postRequest($request, $this->getConfig());
    $this->processErrors($response);
    $this->setTransStatus($payment, $response);
    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Method/Agreement.php#L278-L288


/**
 * Authorize payment
 *
 * @param \Magento\Framework\DataObject|InfoInterface $payment
 * @param float $amount
 * @return $this
 */
public function authorize(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    return $this->_placeOrder($payment, $amount);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Payflow/Transparent.php#L145-L154


/**
 * Performs authorize transaction
 *
 * @param InfoInterface|Object $payment
 * @param float $amount
 * @return $this
 * @throws InvalidTransitionException
 * @throws LocalizedException
 */
public function authorize(InfoInterface $payment, $amount)

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Vault/Model/Method/Vault.php#L391-L415


public function authorize(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    if (!$payment instanceof OrderPaymentInterface) {
        throw new \DomainException('Not implemented');
    }
    /** @var $payment OrderPaymentInterface */


    $this->attachTokenExtensionAttribute($payment);


    $commandExecutor = $this->commandManagerPool->get(
        $this->getVaultProvider()->getCode()
    );


    $commandExecutor->executeByCode(
        VaultPaymentInterface::VAULT_AUTHORIZE_COMMAND,
        $payment,
        [
            'amount' => $amount
        ]
    );


    $payment->setMethod($this->getVaultProvider()->getCode());


    return $this;
}

Usage

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment/Operations/AuthorizeOperation.php#L39-L46


// do authorization
$order = $payment->getOrder();
if ($isOnline) {
    // invoke authorization on gateway
    $method = $payment->getMethodInstance();
    $method->setStore($order->getStoreId());
    $method->authorize($payment, $amount);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment/Processor.php#L62-L73


/**
 * Process authorize operation
 *
 * @param OrderPaymentInterface $payment
 * @param bool $isOnline
 * @param float $amount
 * @return OrderPaymentInterface|Payment
 */
public function authorize(OrderPaymentInterface $payment, $isOnline, $amount)
{
    return $this->authorizeOperation->authorize($payment, $isOnline, $amount);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment.php#L1041-L1055


/**
 * Authorize payment either online or offline (process auth notification)
 * Updates transactions hierarchy, if required
 * Prevents transaction double processing
 * Updates payment totals, updates order status and adds proper comments
 *
 * @param bool $isOnline
 * @param float $amount
 *
 * @return $this
 */
public function authorize($isOnline, $amount)
{
    return $this->orderPaymentProcessor->authorize($this, $isOnline, $amount);
}

Branch 1

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment.php#L420-L424


case \Magento\Payment\Model\Method\AbstractMethod::ACTION_AUTHORIZE:
    $this->authorize(true, $baseTotalDue);
    // base amount will be set inside
    $this->setAmountAuthorized($totalDue);
    break;

How is a payment method’s getConfigPaymentAction() used?

How is \Magento\Sales\Model\Order\Payment::place() used?

Branch 2

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment.php#L466-L476


/**
 * Process authorization notification
 *
 * @param float $amount
 * @return $this
 * @see self::_authorize()
 */
public function registerAuthorizationNotification($amount)
{
    return $this->checkIfTransactionExists() ? $this : $this->authorize(false, $amount);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Ipn.php#L400-L420


protected function _registerPaymentAuthorization()
{
    /** @var $payment \Magento\Sales\Model\Order\Payment */
    $payment = $this->_order->getPayment();
    if ($this->_order->canFetchPaymentReviewUpdate()) {
        $payment->update(true);
    } else {
        $this->_importPaymentInformation();
        $payment->setPreparedMessage(
            $this->_createIpnComment('')
        )->setTransactionId(
            $this->getRequestData('txn_id')
        )->setParentTransactionId(
            $this->getRequestData('parent_txn_id')
        )->setCurrencyCode(
            $this->getRequestData('mc_currency')
        )->setIsTransactionClosed(
            0
        )->registerAuthorizationNotification(
            $this->getRequestData('mc_gross')
        );

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Payflowlink.php#L343-L346


switch ($response->getType()) {
    case self::TRXTYPE_AUTH_ONLY:
        $payment->registerAuthorizationNotification($payment->getBaseAmountAuthorized());
        break;

dmitry_fedyuk · February 14, 2016, 8:18am