How does a payment information saving work when a registered customer places an order?

Development Payment

dmitry_fedyuk (Dmitrii Fediuk) March 2, 2016, 11:16pm 1

Preliminary context:

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Checkout/Model/PaymentInformationManagement.php#L64-L76


public function savePaymentInformationAndPlaceOrder(
    $cartId,
    \Magento\Quote\Api\Data\PaymentInterface $paymentMethod,
    \Magento\Quote\Api\Data\AddressInterface $billingAddress = null
) {
    $this->savePaymentInformation($cartId, $paymentMethod, $billingAddress);
    try {
        $orderId = $this->cartManagement->placeOrder($cartId);
    } catch (\Exception $e) {
        throw new CouldNotSaveException(__('Cannot place order'), $e);
    }
    return $orderId;
}

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Checkout/Model/PaymentInformationManagement.php#L81-L91


public function savePaymentInformation(
    $cartId,
    \Magento\Quote\Api\Data\PaymentInterface $paymentMethod,
    \Magento\Quote\Api\Data\AddressInterface $billingAddress = null
) {
    if ($billingAddress) {
        $this->billingAddressManagement->assign($cartId, $billingAddress);
    }
    $this->paymentMethodManagement->set($cartId, $paymentMethod);
    return true;
}

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Checkout/Model/PaymentInformationManagement.php#L17-L20


/**
 * @var \Magento\Quote\Api\PaymentMethodManagementInterface
 */
protected $paymentMethodManagement;

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Checkout/Model/PaymentInformationManagement.php#L49-L49


\Magento\Quote\Api\PaymentMethodManagementInterface $paymentMethodManagement,

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Checkout/Model/PaymentInformationManagement.php#L55-L55


$this->paymentMethodManagement = $paymentMethodManagement;

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Api/PaymentMethodManagementInterface.php#L8-L24


/**
* Interface PaymentMethodManagementInterface
* @api
*/
interface PaymentMethodManagementInterface
{
   /**
    * Adds a specified payment method to a specified shopping cart.
    *
    * @param int $cartId The cart ID.
    * @param \Magento\Quote\Api\Data\PaymentInterface $method The payment method.
    * @return string redirect url or error message.
    * @throws \Magento\Framework\Exception\NoSuchEntityException The specified cart does not exist.
    * @throws \Magento\Framework\Exception\State\InvalidTransitionException The billing or shipping address
    * is not set, or the specified payment method is not available.
    */
   public function set($cartId, \Magento\Quote\Api\Data\PaymentInterface $method);

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/etc/di.xml#L19-L19


<preference for="Magento\Quote\Api\PaymentMethodManagementInterface" type="\Magento\Quote\Model\PaymentMethodManagement" />

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Model/PaymentMethodManagement.php#L13-L13


class PaymentMethodManagement implements \Magento\Quote\Api\PaymentMethodManagementInterface

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Model/PaymentMethodManagement.php#L47-L50


/**
 * {@inheritdoc}
 */
public function set($cartId, \Magento\Quote\Api\Data\PaymentInterface $method)

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Model/PaymentMethodManagement.php#L52-L53


/** @var \Magento\Quote\Model\Quote $quote */
$quote = $this->quoteRepository->get($cartId);

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Model/QuoteRepository.php#L85-L93


public function get($cartId, array $sharedStoreIds = [])
{
    if (!isset($this->quotesById[$cartId])) {
        $quote = $this->loadQuote('load', 'cartId', $cartId, $sharedStoreIds);
        $this->quotesById[$cartId] = $quote;
        $this->quotesByCustomerId[$quote->getCustomerId()] = $quote;
    }
    return $this->quotesById[$cartId];
}

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Model/PaymentMethodManagement.php#L55-L63


$method->setChecks([
    \Magento\Payment\Model\Method\AbstractMethod::CHECK_USE_CHECKOUT,
    \Magento\Payment\Model\Method\AbstractMethod::CHECK_USE_FOR_COUNTRY,
    \Magento\Payment\Model\Method\AbstractMethod::CHECK_USE_FOR_CURRENCY,
    \Magento\Payment\Model\Method\AbstractMethod::CHECK_ORDER_TOTAL_MIN_MAX,
]);
$payment = $quote->getPayment();


$data = $method->getData();

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Model/PaymentMethodManagement.php#L64-L67


if (isset($data['additional_data'])) {
    $data = array_merge($data, (array)$data['additional_data']);
    unset($data['additional_data']);
}

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Model/Quote/Payment.php#L135-L144


/**
 * Import data array to payment method object,
 * Method calls quote totals collect because payment method availability
 * can be related to quote totals
 *
 * @param array $data
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function importData(array $data)

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Model/Quote/Payment.php#L146-L154


$data = new \Magento\Framework\DataObject($data);
$this->_eventManager->dispatch(
    $this->_eventPrefix . '_import_data_before',
    [$this->_eventObject => $this, 'input' => $data]
);


$this->setMethod($data->getMethod());
$method = $this->getMethodInstance();
$quote = $this->getQuote();

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Model/Quote/Payment.php#L156-L160


/**
 * Payment availability related with quote totals.
 * We have to recollect quote totals before checking
 */
$quote->collectTotals();

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Model/Quote/Payment.php#L162-L167


$methodSpecification = $this->methodSpecificationFactory->create($data->getChecks());
if (!$method->isAvailable($quote) || !$methodSpecification->isApplicable($method, $quote)) {
    throw new \Magento\Framework\Exception\LocalizedException(
        __('The requested Payment Method is not available.')
    );
}

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Payment/Model/MethodInterface.php#L334-L341


/**
 * Assign data to info model instance
 *
 * @param DataObject $data
 * @return $this
 * 
 */
public function assignData(DataObject $data);

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Braintree/Model/PaymentMethod.php#L248-L267


/**
 * Assign corresponding data
 *
 * @param \Magento\Framework\DataObject|mixed $data
 * @return $this
 * @throws LocalizedException
 */
public function assignData(\Magento\Framework\DataObject $data)
{
    parent::assignData($data);
    $infoInstance = $this->getInfoInstance();
    if ($this->getConfigData('fraudprotection') > 0) {
        $infoInstance->setAdditionalInformation('device_data', $data->getData('device_data'));
    }
    $infoInstance->setAdditionalInformation('cc_last4', $data->getData('cc_last4'));
    $infoInstance->setAdditionalInformation('cc_token', $data->getCcToken());
    $infoInstance->setAdditionalInformation('payment_method_nonce', $data->getPaymentMethodNonce());
    $infoInstance->setAdditionalInformation('store_in_vault', $data->getStoreInVault());
    return $this;
}

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Model/Quote/Payment.php#L170-L173


/*
 * validating the payment data
 */
$method->validate();

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

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Braintree/Model/PaymentMethod.php#L275-L304


public function validate()
{
    $info = $this->getInfoInstance();
    if ($info instanceof \Magento\Sales\Model\Order\Payment) {
        $billingCountry = $info->getOrder()->getBillingAddress()->getCountryId();
    } else {
        $billingCountry = $info->getQuote()->getBillingAddress()->getCountryId();
    }


    if (!$this->config->canUseForCountry($billingCountry)) {
        throw new LocalizedException(__('Selected payment type is not allowed for billing country.'));
    }


    $ccType = $info->getCcType();
    if (!$ccType) {
        $token = $this->getInfoInstance()->getAdditionalInformation('cc_token');
        if ($token) {
            $ccType = $this->vault->getSavedCardType($token);
        }
    }


    if ($ccType) {
        $error = $this->config->canUseCcTypeForCountry($billingCountry, $ccType);
        if ($error) {
            throw new LocalizedException($error);
        }
    }


    return $this;
}

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Model/PaymentMethodManagement.php#L70-L81


if ($quote->isVirtual()) {
    $quote->getBillingAddress()->setPaymentMethod($payment->getMethod());
} else {
    // check if shipping address is set
    if ($quote->getShippingAddress()->getCountryId() === null) {
        throw new InvalidTransitionException(__('Shipping address is not set'));
    }
    $quote->getShippingAddress()->setPaymentMethod($payment->getMethod());
}
if (!$quote->isVirtual() && $quote->getShippingAddress()) {
    $quote->getShippingAddress()->setCollectShippingRates(true);
}

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Model/PaymentMethodManagement.php#L83-L85


if (!$this->zeroTotalValidator->isApplicable($payment->getMethodInstance(), $quote)) {
    throw new InvalidTransitionException(__('The requested Payment Method is not available.'));
}

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Payment/Model/Checks/ZeroTotal.php#L13-L24


/**
 * Check whether payment method is applicable to quote
 * Purposed to allow use in controllers some logic that was implemented in blocks only before
 *
 * @param MethodInterface $paymentMethod
 * @param \Magento\Quote\Model\Quote $quote
 * @return bool
 */
public function isApplicable(MethodInterface $paymentMethod, Quote $quote)
{
    return !($quote->getBaseGrandTotal() < 0.0001 && $paymentMethod->getCode() != 'free');
}

The \Magento\Payment\Model\Checks\ZeroTotal::isApplicable() method can be simplified

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Model/PaymentMethodManagement.php#L87-L88


$quote->setTotalsCollectedFlag(false)->collectTotals()->save();
return $quote->getPayment()->getId();

How does \Magento\Webapi\Controller\Rest::processApiRequest() work for a «/carts/mine/payment-information» POST request?

Why is the billing address not saved on an order placement when the customer has chosen my custom payment method?

How does a payment information saving work when a guest customer places an order?

How does the Braintree module use a payment method nonce?

How does a payment information saving work when a guest customer places an order?

dmitry_fedyuk (Dmitrii Fediuk) March 2, 2016, 11:21pm 2

See also:

How does a payment information saving work when a guest customer places an order?