Magento – Magento 2: how to get json posted data in payment method

jsonmagento2payment-methods

Magento is posting payment detail in json format on rest/default/V1/carts/mine/payment-information

Method post

{"cartId":"3","billingAddress":{"countryId":"US","regionId":"0","postcode":null,"saveInAddressBook":null
},"paymentMethod":{"method":"test_method","additional_data":{"testing":"abcdef"
,"temail":"test@test.com"}}}

how to get additional data in my validation method

public function validate()
      {
          /*
           * calling parent validate function
           */
          parent::validate();

          return $this;
      }

Best Answer

Unfortunately, there's no way to directly access the parameters via API (we tried to do that but failed). However, we've found an alternative method to get them.

As you probably know, an API request is also classifed as 'Request', and the parameters are anyway sent to it and stored in the processApiRequest method. If you have a closer look at it, you'll see that the \Magento\Webapi\Controller\Rest\InputParamsResolver deals with the request parameters. Hence, we can use it to extract the needed parameters from the API request.

Add the class \Magento\Webapi\Controller\Rest\InputParamsResolver to the di (dependency injection) of your payment class in the validate method.

You'll get the parameters in the following way:

$inputParams = $inputParamsResolver->resolve();

The result of your request will look somewhat like this (in my example, it was implemented on the Check Money Order method):

additional_data can be found in the instance Magento\Quote\Model\Quote\Payment.

These parameters are exactly the same, as those that are sent to a method called via API:

Just note that this approach has some pitfalls. The parameters come raw, in the array, so you'll have to sort them to find the needed ones.

P.S. If to take the quote payment directly from the quote available via payment info method,

$paymentInfo = $this->getInfoInstance();
$additionalData = $paymentInfo->getQuote()->getPayment()->getData('additional_data');

it's possible to see that the parameter from the request is not there.

Related Solutions

Magento – How to get payment form data in the observer execute method

To get payment details Magento already has the observer - \Magento\Payment\Observer\AbstractDataAssignObserver.

In most cases it will be enough to extend it:

use Magento\Payment\Observer\AbstractDataAssignObserver;

class AdditionalDataReader extends AbstractDataAssignObserver
{

    public function execute(\Magento\Framework\Event\Observer $observer)
    {
        $data = $this->readDataArgument($observer);

        $additionalData = $data->getData(PaymentInterface::KEY_ADDITIONAL_DATA);

        if (!is_array($additionalData)) {
            return;
        }
        // your custom code
    }
}

On the next step, you need to add created observer to list of events in your module (CustomModule/etc/events.xml):

<event name="payment_method_assign_data">
    <observer name="additional_data_reader" instance="CustomPayment\Observer\AdditionalDataReader" />
</event>

Created observer will be triggered when all data will be set to additional_data property (for now, more preferable to use additional_information).

But, your custom payment should sent additional properties from Storefront|Admin panel to the backend.

For example, for Storefront your payment component should overrides getData method:

define(
    ['Magento_Payment/js/view/payment/cc-form'],
    function (Component) {
        'use strict';

        return Component.extend({
            // Your component code
            ...
            getData: function () {
                var data = {
                    'method': 'custom_payment_code',
                    'additional_data': {
                        'custom_field': 'some custom data'
                    }
                };

                return data;
            }
        });
    }
);

UPD: This topic describes how to read payment additional data.

Magento 2.1 – How to Get JSON Data on Frontend Controller

You could use regular JSON response class:

use Magento\Framework\App\Action\Action;
use Magento\Framework\App\Action\Context;
use Magento\Framework\App\ResponseInterface;

class Test extends Action
{

    /**
     * @var \Magento\Framework\Controller\Result\JsonFactory
     */
    protected $resultJsonFactory;

    public function __construct(
        Context $context,
        \Magento\Framework\Controller\Result\JsonFactory $resultJsonFactory
    ) {
        parent::__construct($context);
        $this->resultJsonFactory = $resultJsonFactory;
    }

    /**
     * Dispatch request
     *
     * @return \Magento\Framework\Controller\ResultInterface|ResponseInterface
     * @throws \Magento\Framework\Exception\NotFoundException
     */
    public function execute()
    {
        /** @var \Magento\Framework\Controller\Result\Json $result */
        $result = $this->resultJsonFactory->create();
        $resultData = [
            'any_key' => 'Any data goes here',
            'success' => true,
            'time' => time(),
            'replace_button_message' => __('Your store has been already registered'),
        ];

        return $result->setData($resultData);
    }
}

Best Answer

Related Solutions

Magento – How to get payment form data in the observer execute method

Magento 2.1 – How to Get JSON Data on Frontend Controller

Related Topic