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

dmitry_fedyuk · February 10, 2016, 9:42pm

Context: How to get an order payment by its ID?

Declaration

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


/**
 * Check fetch transaction info availability
 *
 * @return bool
 * 
 */
public function canFetchTransactionInfo();

Definition

github.com

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


/**
 * Check fetch transaction info availability
 *
 * @return bool
 * @api
 */
public function canFetchTransactionInfo()
{
    return $this->_canFetchTransactionInfo;
}

Usages

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Block/Adminhtml/Transactions/Detail.php#L83-L93


$canFetchTransaction = $this->orderPaymentRepository->get($this->_txn->getPaymentId())
    ->getMethodInstance()
    ->canFetchTransactionInfo();


if ($fetchTransactionAllowed && $canFetchTransaction) {
    $fetchUrl = $this->getUrl('sales/*/fetch', ['_current' => true]);
    $this->buttonList->add(
        'fetch',
        ['label' => __('Fetch'), 'onclick' => "setLocation('{$fetchUrl}')", 'class' => 'button']
    );
}

github.com

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


public function canFetchTransactionInfo()
{
    return (bool)$this->getMethodInstance()->canFetchTransactionInfo();
}

github.com

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


/**
 * Fetch an update about existing transaction. It can determine whether the transaction can be paid
 * Capture attempt will happen only when invoice is not yet paid and the transaction can be paid
 */
if ($invoice->getTransactionId()) {
    $method = $payment->getMethodInstance();
    $method->setStore(
        $order->getStoreId()
    );
    if ($method->canFetchTransactionInfo()) {
        $method->fetchTransactionInfo(
            $payment,
            $invoice->getTransactionId()
        );
    }
}

dmitry_fedyuk · February 10, 2016, 9:45pm