Magento – Magento2 How To Get Order Id from orderFactory in custom Controller in the own custom payment gateway module

magento2orders

I wanted to know how to get orderid of the current order which have now been redirected to my own custom controller in my own custom payment gateway module in Magento2 using orderFactory?

        namespace Vendor\CustomPayment\Controller\Redirect;

        use Magento\Framework\Controller\ResultFactory;
        use Magento\Framework\Webapi\Soap\ClientFactory;
        use Magento\Payment\Gateway\Http\ClientInterface;
        use Magento\Payment\Gateway\Http\ConverterInterface;
        use Magento\Payment\Gateway\Http\TransferInterface;
        use Magento\Payment\Model\Method\Logger;
        use Magento\Checkout\Model\Cart;
        use Magento\Checkout\Model\Session;
        use Magento\Sales\Model\OrderFactory;

        //use Zend\Soap\Client;
        //use Zend\Soap;
        use SoapClient;

        class Index extends \Magento\Framework\App\Action\Action 
        {


            protected $resultPageFactory;
            protected $orderFactory;

            protected $client;
            protected $MerchantID;
            protected $Amount;
            protected $Description;
            protected $Email;
            protected $Mobile;
            protected $CallbackURL;

        // URL also can be ir.CustomPayment.com or de.CustomPayment.com
        //    private $client = new SoapClient('https://www.CustomPayment.com/pg/services/WebGate/wsdl', ['encoding' => 'UTF-8']);


            /**
             * Constructor
             *
             * @param \Magento\Framework\App\Action\Context  $context
             * @param \Magento\Framework\View\Result\PageFactory $resultPageFactory
             */
            public function __construct(
                \Magento\Framework\App\Action\Context $context,
                \Magento\Framework\View\Result\PageFactory $resultPageFactory,
                    \Magento\Sales\Model\OrderFactory $orderFactory
            ) {

                $this->resultPageFactory = $resultPageFactory;
                $this->orderFactory = $orderFactory;
                parent::__construct($context);
        //        $this->_order = $_order; // <-- new line





            }

            /**
             * Execute view action
             *
             * @return \Magento\Framework\Controller\ResultInterface
             */
            public function execute()
            {

                $orderId = $this->getRequest()->getParam('order_id');
                $order = $this->orderFactory->create();
                $order->load($orderId);
                $customerId = $order->getCustomerId();
                echo $customerId;
                exit();
                $objectManager = \Magento\Framework\App\ObjectManager::getInstance();
            //    $order_id = $objectManager
                $cart = $objectManager->get('\Magento\Checkout\Model\Cart'); 
                $grandTotal = $cart->getQuote()->getGrandTotal();

        //    $orderModel = $this->_objectManager->create('\Magento\Sales\Model\Order'); 
        //    $order = $orderModel->load($orderId);
        //    $currentState = $order->getState();
        //    $currentStatus = $order->getStatus();
        //
        //    $save = false;
        //    if ($currentState !== $orderModel::STATE_NEW) {
        //        $order->setState($orderModel::STATE_NEW);
        //        $save = true;
        //    }
        //
        //    if ($currentStatus !== $orderModel::STATUS_FRAUD) {
        //        $order->setStatus($orderModel::STATUS_FRAUD);
        //        $save = true;
        //    }   
        //
        //    if ($save) { $order->save(); }

                $MerchantID = '456ad7f2-ae1c-11e6-bcba-000c295eb8fc';  //Required
                $Amount = $grandTotal; //Amount will be based on Toman  - Required
                $Description = 'توضیحات تراکنش تستی';  // Required
                $Email = 'UserEmail@Mail.Com'; // Optional
                $Mobile = '09123456789'; // Optional
                $CallbackURL = 'http://bist20.com/callback/Callback';  // Required
                $client = new SoapClient('https://www.CustomPayment.com/pg/services/WebGate/wsdl', ['encoding' => 'UTF-8']);

                $result = $client->PaymentRequest([
                            'MerchantID'     => $MerchantID,
                            'Amount'         => $Amount,
                            'Description'    => $Description,
                            'Email'          => $Email,
                            'Mobile'         => $Mobile,
                            'CallbackURL'    => $CallbackURL,
                        ]);

                        //Redirect to URL You can do it also by creating a form
                        if ($result->Status == 100) {
                            $resultRedirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT);
                            $resultRedirect->setUrl("https://www.CustomPayment.com/pg/StartPay/".$result->Authority);
                            return $resultRedirect;
                        } else {
                            echo'ERR: '.$result->Status;
                        }



            }

        }

Best Answer

At your Controller __construct() function,

you should inject Check Session class \Magento\Checkout\Model\Session and from this class you will get Order Id

Then using Order factory class you can order object

    /**
     * @var \Magento\Checkout\Model\Session
     */
    protected $_checkoutSession;

    /**
     * @var \Magento\Sales\Model\OrderFactory
     */
    protected $_orderFactory;

  public function __construct(
          ..... 
        \Magento\Checkout\Model\Session $checkoutSession,
        \Magento\Sales\Model\OrderFactory $orderFactory,
         .....
    ) {
        $this->_checkoutSession = $checkoutSession;
        $this->_orderFactory = $orderFactory;
        .....
    }

    /**
     * Get order object
     *
     * @return \Magento\Sales\Model\Order
     */
    protected function getOrder()
    {
        return $this->_orderFactory->create()->loadByIncrementId(
            $this->_checkoutSession->getLastRealOrderId()
        );
    }

Update

<?php
  namespace Vendor\CustomPayment\Controller\Redirect;

        use Magento\Framework\Controller\ResultFactory;
        use Magento\Framework\Webapi\Soap\ClientFactory;
        use Magento\Payment\Gateway\Http\ClientInterface;
        use Magento\Payment\Gateway\Http\ConverterInterface;
        use Magento\Payment\Gateway\Http\TransferInterface;
        use Magento\Payment\Model\Method\Logger;
        use Magento\Checkout\Model\Cart;
        use Magento\Checkout\Model\Session;

        //use Zend\Soap\Client;
        //use Zend\Soap;
        use SoapClient;

        class Index extends \Magento\Framework\App\Action\Action 
        {


            protected $resultPageFactory;
            protected $orderFactory;

            protected $client;
            protected $MerchantID;
            protected $Amount;
            protected $Description;
            protected $Email;
            protected $Mobile;
            protected $CallbackURL;
            protected $_checkoutSession;

        // URL also can be ir.CustomPayment.com or de.CustomPayment.com
        //    private $client = new SoapClient('https://www.CustomPayment.com/pg/services/WebGate/wsdl', ['encoding' => 'UTF-8']);


            /**
             * Constructor
             *
             * @param \Magento\Framework\App\Action\Context  $context
             * @param \Magento\Framework\View\Result\PageFactory $resultPageFactory
             */
            public function __construct(
                \Magento\Framework\App\Action\Context $context,
                \Magento\Framework\View\Result\PageFactory $resultPageFactory,
                \Magento\Sales\Model\OrderFactory $orderFactory,
                Session $checkoutSession
            ) {
                $this->resultPageFactory = $resultPageFactory;
                $this->orderFactory = $orderFactory;
                $this->_checkoutSession = $checkoutSession;
                parent::__construct($context);
            }

            /**
             * Execute view action
             *
             * @return \Magento\Framework\Controller\ResultInterface
             */
            public function execute()
            {

                $orderId = $this->getRequest()->getParam('order_id');
                $orderIncrementId = $this->_checkoutSession->getLastRealOrderId();
                $order = $this->orderFactory->create();
                $order->loadByIncrementId($orderIncrementId);

                $customerId = $order->getCustomerId();

                $grandTotal = $order->getGrandTotal();


                $MerchantID = '456ad7f2-ae1c-11e6-bcba-000c295eb8fc';  //Required
                $Amount = $grandTotal; //Amount will be based on Toman  - Required
                $Description = 'توضیحات تراکنش تستی';  // Required
                $Email = 'UserEmail@Mail.Com'; // Optional
                $Mobile = '09123456789'; // Optional
                $CallbackURL = 'http://bist20.com/callback/Callback';  // Required
                $client = new SoapClient('https://www.CustomPayment.com/pg/services/WebGate/wsdl', ['encoding' => 'UTF-8']);

                $result = $client->PaymentRequest([
                            'MerchantID'     => $MerchantID,
                            'Amount'         => $Amount,
                            'Description'    => $Description,
                            'Email'          => $Email,
                            'Mobile'         => $Mobile,
                            'CallbackURL'    => $CallbackURL,
                        ]);

                        //Redirect to URL You can do it also by creating a form
                        if ($result->Status == 100) {
                            $resultRedirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT);
                            $resultRedirect->setUrl("https://www.CustomPayment.com/pg/StartPay/".$result->Authority);
                            return $resultRedirect;
                        } else {
                            echo'ERR: '.$result->Status;
                        }



            }

        }

Related Solutions

Magento 2.1 – Use urlBuilder->getUrl() in Custom Module Controller

If your controller extend Magento\Framework\App\Action\Action you should follow rules of creation of the controller. So you should implement dependency injection of the parent class constructor (Magento\Framework\App\Action\Action):

/**
 * @param Context $context
 */
public function __construct(Context $context)
{
    parent::__construct($context);
    $this->_objectManager = $context->getObjectManager();
    $this->_eventManager = $context->getEventManager();
    $this->_url = $context->getUrl();
    $this->_actionFlag = $context->getActionFlag();
    $this->_redirect = $context->getRedirect();
    $this->_view = $context->getView();
    $this->messageManager = $context->getMessageManager();
}

Your construct method should look like this after a modifications:

/**
 * @param Context $context
 * @param UrlInterface $urlBuilder
 */
public function __construct(
    Context $context,
    UrlInterface $urlBuilder
) {
    parent::__construct($context);
    $this->urlBuilder = $urlBuilder;
}

NOTE: do not forget to remove old var/generation directory after implementing of modifications, because there are stored the generated files of controllers.

Magento 2 – Payment Gateway with Redirects

In order to implement custom payment module with redirect you have to implement the following logic:

Create Frontend logic responsible for rendering custom payment method with "Place Order" button.
Configure payment method for "initialisation" during placing order, so Order will be placed with "Pending Payment" status.
Once "place order" logic is executed and order is saved via default JavaScript Payment component you have to send WebAPI POST request to backend server (in case you need to send HTTP POST to a payment method before redirecting customer).

You should implement whole Payment Gateway infrastructure of classes:

Builders classes for pre-populating POST parameters for request
Handlers for processing response from payment gateway
Validators for verifying response from payment gateway
Custom commands in case GatewayCommand does not work for you and you need own processing logic when sending request to a payment provider.
New Magento/Payment/Model/Method/Adapter class is now a centric for payment integrations, it is a must have to configure it with custom commands.

Retrieve result to custom JavaScript component from Web API call execution and then redirect Customer to a Payment page.
Create controllers, 1 for success and second one for failure in case Payment provider allows to set 2 URLs for each state. If not, create 1 controller where depending on a validation and additional logic you need to add in order to change status and create "capture" or "authorise" payment render different layout updates "custompayment_success" or "custompayment_error".

Few clarifications:

Class Magento\Payment\Model\Method\Cc is indeed deprecated and should not be used.
Interface Magento\Payment\Gateway\Http\ClientInterface should be used for sending background requests to a payment gateway. There is even 2 implementations for ClientInterface

Should you have any questions please let me know.

Best Answer

Related Solutions

Magento 2.1 – Use urlBuilder->getUrl() in Custom Module Controller

Magento 2 – Payment Gateway with Redirects

Related Topic