How to get an order payment by its ID?

dmitry_fedyuk · May 7, 2016, 9:02am

Interface: \Magento\Sales\Api\OrderPaymentRepositoryInterface::get()

https://github.com/magento/magento2/blob/ffea3cd/app/code/Magento/Sales/Api/OrderPaymentRepositoryInterface.php#L26-L32

Implementation: \Magento\Sales\Model\Order\Payment\Repository::get()

magento/magento2/blob/ffea3cd/app/code/Magento/Sales/Model/Order/Payment/Repository.php#L68-L88


/**
 * Loads a specified order payment.
 *
 * @param int $id The order payment ID.
 * @return \Magento\Sales\Api\Data\OrderPaymentInterface Order payment interface.
 * @throws NoSuchEntityException
 * @throws \Magento\Framework\Exception\InputException
 */
public function get($id)
{
    if (!$id) {
        throw new \Magento\Framework\Exception\InputException(__('ID required'));
    }
    if (!isset($this->registry[$id])) {
        $entity = $this->metaData->getNewInstance()->load($id);
        if (!$entity->getId()) {
            throw new NoSuchEntityException(__('Requested entity doesn\'t exist'));
        }
        $this->registry[$id] = $entity;
    }
    return $this->registry[$id];

Usages

1. \Magento\Sales\Block\Adminhtml\Transactions\Detail::_construct()

github.com

magento/magento2/blob/ffea3cd/app/code/Magento/Sales/Block/Adminhtml/Transactions/Detail.php#L83-L85


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

Details: How is a payment method’s canFetchTransactionInfo() used?

2. \Magento\Sales\Controller\Adminhtml\Transactions\Fetch::execute()

github.com

magento/magento2/blob/ffea3cd/app/code/Magento/Sales/Controller/Adminhtml/Transactions/Fetch.php#L36-L38


$this->orderPaymentRepository->get($txn->getId())->setOrder($txn->getOrder())->importTransactionInfo($txn);
$txn->save();
$this->messageManager->addSuccess(__('The transaction details have been updated.'));

3. \Magento\Sales\Model\Order\Payment\Transaction::getOrderId()

https://github.com/magento/magento2/blob/ffea3cd/app/code/Magento/Sales/Model/Order/Payment/Transaction.php#L536-L556