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

dmitrii_fediuk · February 14, 2016, 11:13pm

Declaration

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


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

Definition

github.com

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


/**
 * Capture 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 capture(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    if (!$this->canCapture()) {
        throw new \Magento\Framework\Exception\LocalizedException(__('The capture action is not available.'));
    }


    return $this;
}

github.com

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


/**
 * Send capture request to gateway
 *
 * @param \Magento\Framework\DataObject|\Magento\Payment\Model\InfoInterface $payment
 * @param float $amount
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function capture(\Magento\Payment\Model\InfoInterface $payment, $amount)

github.com

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


/**
 * Captures specified amount
 *
 * @param InfoInterface $payment
 * @param string $amount
 * @return $this
 * @throws LocalizedException
 */
public function capture(InfoInterface $payment, $amount)

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Braintree/Model/PaymentMethod/PayPal.php#L282-L291


/**
 * Captures specified amount, override the method in Braintree CC method as transaction through PayPal does not
 * can't be cloned
 *
 * @param InfoInterface $payment
 * @param float $amount
 * @return $this
 * @throws LocalizedException
 */
public function capture(InfoInterface $payment, $amount)

github.com

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


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


    return $this;
}

github.com

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


/**
 * Capture payment
 *
 * @param \Magento\Framework\DataObject|\Magento\Payment\Model\InfoInterface|Payment $payment
 * @param float $amount
 * @return $this
 */
public function capture(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    if (false === $this->_pro->capture($payment, $amount)) {
        $this->_placeOrder($payment, $amount);
    }
    return $this;
}

github.com

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


/**
 * Capture payment
 *
 * @param \Magento\Framework\DataObject|\Magento\Payment\Model\InfoInterface|Payment $payment
 * @param float $amount
 * @return $this
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 * @SuppressWarnings(PHPMD.NPathComplexity)
 */
public function capture(\Magento\Payment\Model\InfoInterface $payment, $amount)

github.com

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


/**
 * Capture payment
 *
 * @param InfoInterface|Payment|Object $payment
 * @param float $amount
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 * @throws \Magento\Framework\Exception\State\InvalidTransitionException
 */
public function capture(\Magento\Payment\Model\InfoInterface $payment, $amount)

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Pro.php#L245-L253


/**
 * Attempt to capture payment
 * Will return false if the payment is not supposed to be captured
 *
 * @param \Magento\Framework\DataObject $payment
 * @param float $amount
 * @return false|null
 */
public function capture(\Magento\Framework\DataObject $payment, $amount)

github.com

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


/**
 * Capture payment
 *
 * @param \Magento\Framework\DataObject|InfoInterface|Payment $payment
 * @param float $amount
 * @return $this
 */
public function capture(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    if (false === $this->_pro->capture($payment, $amount)) {
        $this->_placeOrder($payment, $amount);
    }
    return $this;
}

github.com

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


/**
 * Capture payment
 *
 * @param InfoInterface|Payment $payment
 * @param float $amount
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 * @throws \Magento\Framework\Exception\State\InvalidTransitionException
 */
public function capture(InfoInterface $payment, $amount)
{
    /** @var Payment $payment */
    $token = $payment->getAdditionalInformation(self::PNREF);
    parent::capture($payment, $amount);


    if ($token && !$payment->getAuthorizationTransaction()) {
        $this->createPaymentToken($payment, $token);
    }


    return $this;
}

github.com

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


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


    if ($payment->getAuthorizationTransaction()) {
        throw new \DomainException('Capture can not be performed through vault');
    }


    $this->attachTokenExtensionAttribute($payment);


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


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


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

The single usage

\Magento\Sales\Model\Order\Payment\Operations\CaptureOperation::capture()

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment/Operations/CaptureOperation.php#L76-L82


// attempt to capture: this can trigger "is_transaction_pending"
$method = $payment->getMethodInstance();
$method->setStore(
    $order->getStoreId()
);
//TODO replace for sale usage
$method->capture($payment, $amountToCapture);

Details: How is \Magento\Sales\Model\Order\Payment\Operations\CaptureOperation::capture() implemented and used?

dmitrii_fediuk · February 14, 2016, 11:26pm