{"id":339766,"date":"2022-06-16T07:18:52","date_gmt":"2022-06-16T07:18:52","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=339766"},"modified":"2023-05-09T11:14:29","modified_gmt":"2023-05-09T11:14:29","slug":"how-to-add-custom-field-for-a-payment-method-in-magento2","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/","title":{"rendered":"How to add custom field for a payment method in Magento 2?"},"content":{"rendered":"\n

This topic describes how to add a custom field to a payment method in the payment step of the checkout. The custom field allows the buyer to enter the phone for an payment method.<\/p>\n\n\n\n

Step 1 – Create a new module <\/strong>
Create a new module named Learning\/PaymentMethod and register it.<\/p>\n\n\n\n

Step 2 Add a db_schema.xml file.<\/strong>
Add the mpesanumber column in the quote_payment and sales_order_payment tables using the declarative schema method.<\/p>\n\n\n\n

Create the app\/code\/Learning\/PaymentMethod\/etc\/db_schema.xml and define the declarative schema as follows:<\/p>\n\n\n\n

<schema xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Setup\/Declaration\/Schema\/etc\/schema.xsd">\n    \n    <table name="quote_payment" resource="checkout" engine="innodb" comment="Sales Flat Quote Payment">\n        <column xsi:type="text" name="mpesanumber" nullable="true" comment="Mpesa Mobile Number"\/>\n    <\/table>\n    <table name="sales_order_payment" resource="sales" engine="innodb" comment="Sales Flat Order Payment">\n        <column xsi:type="text" name="mpesanumber" nullable="true" comment="Mpesa Mobile Number"\/>\n    <\/table>\n<\/schema><\/pre>\n\n\n\n
Step 3- Override the payment method js files or if using new Magento 2 payment method<\/a> then add the code in the below files.<\/strong>
Create the app\/code\/Learning\/PaymentMethod\/view\/frontend\/web\/js\/view\/payment\/testmethod.js file and add the following code:
<\/p>\n\n\n\n
\n define(\n    [\n        'uiComponent',\n        'Magento_Checkout\/js\/model\/payment\/renderer-list'\n    ],\n    function (Component,\n              rendererList) {\n        'use strict';\n        rendererList.push(\n            {\n                type: 'testmethod',\n                component: 'Learning_PaymentMethod\/js\/view\/payment\/method-renderer\/testmethod'\n            }\n        );\n        return Component.extend({});\n    }\n);<\/pre>\n\n\n\n

Create the app\/code\/Learning\/PaymentMethod\/view\/frontend\/web\/js\/view\/payment\/method-renderer\/testmethod.js file and add the following code:
<\/p>\n\n\n\n
\ndefine(\n    [\n        'jquery',\n        'Magento_Checkout\/js\/view\/payment\/default',\n        'mage\/url',\n        'Magento_Checkout\/js\/model\/error-processor',\n        'Magento_Checkout\/js\/action\/redirect-on-success',\n        'Magento_Checkout\/js\/model\/quote',\n        'mage\/validation'\n    ],\n    function ($,Component,url, errorProcessor,redirectOnSuccessAction, quote) {\n        'use strict';\n        \n        return Component.extend({\n            defaults: {\n                template: 'Learning_PaymentMethod\/payment\/testmethod',\n                mpesaNumber:'',\n            },\n            \/** @inheritdoc *\/\n            initObservable: function () {\n                this._super()\n                    .observe(['mpesaNumber']);\n\n                return this;\n            },\n            \/**\n         * @return {Object}\n         *\/\n        getData: function () {\n            return {\n                method: this.item.method,\n                \/\/ 'mpesanumber': this.mpesaNumber(),\n                'additional_data': {\n                    'mpesanumber': $('#lipampesanumber').val()\n                }\n            };\n        },\n        \/**\n         * @return {jQuery}\n         *\/\n        validate: function () {\n            var form = 'form[data-role=mpesanumber_form]';\n\n            return $(form).validation() && $(form).validation('isValid');\n        },\n       \n        });\n    }\n);<\/pre>\n\n\n\n

Create the app\/code\/Learning\/PaymentMethod\/view\/frontend\/web\/template\/payment\/testmethod.html file and add the following code:
<\/p>\n\n\n\n
<div class="payment-method" data-bind="css: {'_active': (getCode() == isChecked())}">\n    <div class="payment-method-title field choice">\n        <input type="radio"\n               name="payment[method]"\n               class="radio"\n               data-bind="attr: {'id': getCode()}, value: getCode(), checked: isChecked, click: selectPaymentMethod, visible: isRadioButtonVisible()"\/>\n        \n        <label data-bind="attr: {'for': getCode()}" class="label">\n            <span data-bind="text: getTitle()"><\/span>\n        <\/label>\n    <\/div>\n\n    <div class="payment-method-content">\n        <!-- ko foreach: getRegion('messages') -->\n        <!-- ko template: getTemplate() --><!-- \/ko -->\n        <!--\/ko-->\n        <div class="payment-method-billing-address">\n            <!-- ko foreach: $parent.getRegion(getBillingAddressFormName()) -->\n            <!-- ko template: getTemplate() --><!-- \/ko -->\n            <!--\/ko-->\n        <\/div>\n        <form id="mpesanumber_form" class="form form-mpsaisa-number" data-role="mpesanumber_form">\n            <fieldset class="fieldset payment method" data-bind='attr: {id: "payment_form_" + getCode()}'>\n                <div class="field field-number required">\n                    <label for="mpesanumber" class="label">\n                    <span><!-- ko i18n: 'Mpesa Mobile Number'--><!-- \/ko --><\/span>\n                    <\/label>\n                    <div class="control">\n                        <div class="name-info">\n                            <input type="text" id="lipampesanumber" name="payment[mpesanumber]" \n                            placeholder="Mpesa Mobile Number" data-validate="{required:true}"        data-bind='attr: {title: $t("Mpaisa Mobile Number")}' class="input-text"\/>\n                        <\/div>\n                    <\/div>\n                <\/div>\n            <\/fieldset>\n        <\/form>\n        <div class="checkout-agreements-block">\n            <!-- ko foreach: $parent.getRegion('before-place-order') -->\n                <!-- ko template: getTemplate() --><!-- \/ko -->\n            <!--\/ko-->\n        <\/div>\n        <div class="actions-toolbar" id="review-buttons-container">\n            <div class="primary">\n                <button class="action primary checkout"\n                        type="submit"\n                        data-bind="\n                        click: placeOrder,\n                        attr: {title: $t('Place Order')},\n                        enable: (getCode() == isChecked()),\n                        css: {disabled: !isPlaceOrderActionAllowed()}\n                        "\n                        data-role="review-save">\n                    <span data-bind="i18n: 'Place Order'"><\/span>\n                <\/button>\n            <\/div>\n        <\/div>\n    <\/div>\n<\/div><\/pre>\n\n\n\n

Step 5: Add an Observer<\/strong>
Create an Observer file to save the custom field data to the order. For the Observer file an events.xml file is required to call the observer for a particular event. For this example, the sales_model_service_quote_submit_before event is used.

Create the app\/code\/Learning\/PaymentMethod\/etc\/frontend\/events.xml file and add the following code:<\/p>\n\n\n\n
<?xml version="1.0"?>\n<config xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event\/etc\/events.xsd">\n\t\n    <event name="sales_model_service_quote_submit_before">\n        <observer name="mpesa_field_observer_frontend_sales_orderpaymentsavebefore" instance="Learning\\PaymentMethod\\Observer\\OrderPaymentSaveBefore" \/>\n    <\/event>\n    \n<\/config><\/pre>\n\n\n\n

Then create the app\/code\/Learning\/PaymentMethod\/Observer\/OrderPaymentSaveBefore.php file.
<\/p>\n\n\n\n
<?php\n\nnamespace Learning\\PaymentMethod\\Observer;\n\nuse Magento\\Framework\\Event\\Observer as EventObserver;\nuse Magento\\Framework\\Event\\ObserverInterface;\nuse Magento\\OfflinePayments\\Model\\Purchaseorder;\nuse Magento\\Framework\\App\\Request\\DataPersistorInterface;\n\nclass OrderPaymentSaveBefore implements \\Magento\\Framework\\Event\\ObserverInterface\n{\n\n    \/**\n     * Construct\n     *\n     * @param \\Magento\\Sales\\Api\\Data\\OrderInterface $order\n     * @param \\Magento\\Quote\\Api\\CartRepositoryInterface $quoteRepository\n     * @param \\Psr\\Log\\LoggerInterface $logger\n     * @param \\Magento\\Framework\\Serialize\\Serializer\\Serialize $serialize\n     * @param \\Magento\\Webapi\\Controller\\Rest\\InputParamsResolver $inputParamsResolver\n     * @param \\Magento\\Framework\\App\\State $state\n     *\/\n    public function __construct(\n        \\Magento\\Sales\\Api\\Data\\OrderInterface $order,\n        \\Magento\\Quote\\Api\\CartRepositoryInterface $quoteRepository,\n        \\Psr\\Log\\LoggerInterface $logger,\n        \\Magento\\Framework\\Serialize\\Serializer\\Serialize $serialize,\n        \\Magento\\Webapi\\Controller\\Rest\\InputParamsResolver $inputParamsResolver,\n        \\Magento\\Framework\\App\\State $state\n    ) {\n        $this->order = $order;\n        $this->quoteRepository = $quoteRepository;\n        $this->logger = $logger;\n        $this->_serialize = $serialize;\n        $this->inputParamsResolver = $inputParamsResolver;\n        $this->_state = $state;\n    }\n    \n    public function execute(\\Magento\\Framework\\Event\\Observer $observer)\n    {\n        $order = $observer->getOrder();\n        $inputParams = $this->inputParamsResolver->resolve();\n        if ($this->_state->getAreaCode() != \\Magento\\Framework\\App\\Area::AREA_ADMINHTML) {\n            foreach ($inputParams as $inputParam) {\n                if ($inputParam instanceof \\Magento\\Quote\\Model\\Quote\\Payment) {\n                    $paymentData = $inputParam->getData('additional_data');\n                    \n                    $paymentOrder = $order->getPayment();\n                    $order = $paymentOrder->getOrder();\n                    $quote = $this->quoteRepository->get($order->getQuoteId());\n                    $paymentQuote = $quote->getPayment();\n                    $method = $paymentQuote->getMethodInstance()->getCode();\n                    if ($method == 'testmethod') {\n                        if (isset($paymentData['mpesanumber'])) {\n                            $paymentQuote->setData('mpesanumber', $paymentData['mpesanumber']);\n                            $paymentOrder->setData('mpesanumber', $paymentData['mpesanumber']);\n                        }\n                        \n                    }\n                }\n            }\n        }\n    }\n}<\/pre>\n\n\n\n

Step 6: Compile and deploy the module
<\/strong>Run the following sequence of commands to compile and deploy your custom module.<\/p>\n\n\n\n
Enable the new module.<\/p>\n\n\n\n
bin\/magento module:enable Learning_PaymentMethod
Install the new module.<\/p>\n\n\n\n
bin\/magento setup:upgrade
Compile the code.<\/p>\n\n\n\n
bin\/magento setup:di:compile
Deploy the static files.<\/p>\n\n\n\n
bin\/magento setup:static-content:deploy
Step 7: Verify that the module works<\/strong><\/p>\n\n\n\n
\"payment_method\"<\/figure>\n\n\n\n
We hope it will help you. Thank you!!<\/p>\n\n\n\n
If any issue or doubt please feel free to mention in comment section.<\/p>\n\n\n\n
We would be happy to help. Happy Coding!!<\/p>\n","protected":false},"excerpt":{"rendered":"
This topic describes how to add a custom field to a payment method in the payment step of the checkout. The custom field allows the buyer to enter the phone for an payment method. Step 1 – Create a new module Create a new module named Learning\/PaymentMethod and register it. Step 2 Add a db_schema.xml […]<\/a><\/p>\n","protected":false},"author":375,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[1161,2070,3301],"class_list":["post-339766","post","type-post","status-publish","format-standard","hentry","category-uncategorized","tag-checkout","tag-magento2","tag-payment-methods"],"yoast_head":"\nHow to add custom field for a payment method in Magento 2? - Webkul Blog<\/title>\n<meta name=\"description\" content=\"Follow this tutorial to add a custom field for a payment method in Magento 2 at the checkout step. Custom field allows buyers to enter a phone for a payment method.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to add custom field for a payment method in Magento 2? - Webkul Blog\" \/>\n<meta property=\"og:description\" content=\"Follow this tutorial to add a custom field for a payment method in Magento 2 at the checkout step. Custom field allows buyers to enter a phone for a payment method.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/\" \/>\n<meta property=\"og:site_name\" content=\"Webkul Blog\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/webkul\/\" \/>\n<meta property=\"article:published_time\" content=\"2022-06-16T07:18:52+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2023-05-09T11:14:29+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/06\/payment_method-1200x603.png\" \/>\n<meta name=\"author\" content=\"Radhika Garg\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@webkul\" \/>\n<meta name=\"twitter:site\" content=\"@webkul\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Radhika Garg\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/\"},\"author\":{\"name\":\"Radhika Garg\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/1bfed7985110d44a908d093a4e322727\"},\"headline\":\"How to add custom field for a payment method in Magento 2?\",\"datePublished\":\"2022-06-16T07:18:52+00:00\",\"dateModified\":\"2023-05-09T11:14:29+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/\"},\"wordCount\":347,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/06\/payment_method-1200x603.png\",\"keywords\":[\"Checkout\",\"Magento2\",\"payment methods\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/\",\"url\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/\",\"name\":\"How to add custom field for a payment method in Magento 2? - Webkul Blog\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/06\/payment_method-1200x603.png\",\"datePublished\":\"2022-06-16T07:18:52+00:00\",\"dateModified\":\"2023-05-09T11:14:29+00:00\",\"description\":\"Follow this tutorial to add a custom field for a payment method in Magento 2 at the checkout step. Custom field allows buyers to enter a phone for a payment method.\",\"breadcrumb\":{\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#primaryimage\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2022\/06\/payment_method.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2022\/06\/payment_method.png\",\"width\":1528,\"height\":768,\"caption\":\"payment_method\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webkul.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How to add custom field for a payment method in Magento 2?\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/webkul.com\/blog\/#website\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"name\":\"Webkul Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/webkul.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/webkul.com\/blog\/#organization\",\"name\":\"WebKul Software Private Limited\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"width\":380,\"height\":380,\"caption\":\"WebKul Software Private Limited\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/webkul\/\",\"https:\/\/x.com\/webkul\",\"https:\/\/www.instagram.com\/webkul\/\",\"https:\/\/www.linkedin.com\/company\/webkul\",\"https:\/\/www.youtube.com\/user\/webkul\/\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/1bfed7985110d44a908d093a4e322727\",\"name\":\"Radhika Garg\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/2319613aaa0bc878e7855f009fc5a889134810d78fa0d1e693180b36f82156a3?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/2319613aaa0bc878e7855f009fc5a889134810d78fa0d1e693180b36f82156a3?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"caption\":\"Radhika Garg\"},\"url\":\"https:\/\/webkul.com\/blog\/author\/radhika-garg178\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"How to add custom field for a payment method in Magento 2? - Webkul Blog","description":"Follow this tutorial to add a custom field for a payment method in Magento 2 at the checkout step. Custom field allows buyers to enter a phone for a payment method.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/","og_locale":"en_US","og_type":"article","og_title":"How to add custom field for a payment method in Magento 2? - Webkul Blog","og_description":"Follow this tutorial to add a custom field for a payment method in Magento 2 at the checkout step. Custom field allows buyers to enter a phone for a payment method.","og_url":"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/","og_site_name":"Webkul Blog","article_publisher":"https:\/\/www.facebook.com\/webkul\/","article_published_time":"2022-06-16T07:18:52+00:00","article_modified_time":"2023-05-09T11:14:29+00:00","og_image":[{"url":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/06\/payment_method-1200x603.png","type":"","width":"","height":""}],"author":"Radhika Garg","twitter_card":"summary_large_image","twitter_creator":"@webkul","twitter_site":"@webkul","twitter_misc":{"Written by":"Radhika Garg","Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#article","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/"},"author":{"name":"Radhika Garg","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/1bfed7985110d44a908d093a4e322727"},"headline":"How to add custom field for a payment method in Magento 2?","datePublished":"2022-06-16T07:18:52+00:00","dateModified":"2023-05-09T11:14:29+00:00","mainEntityOfPage":{"@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/"},"wordCount":347,"commentCount":0,"publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"image":{"@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/06\/payment_method-1200x603.png","keywords":["Checkout","Magento2","payment methods"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/","url":"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/","name":"How to add custom field for a payment method in Magento 2? - Webkul Blog","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#primaryimage"},"image":{"@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/06\/payment_method-1200x603.png","datePublished":"2022-06-16T07:18:52+00:00","dateModified":"2023-05-09T11:14:29+00:00","description":"Follow this tutorial to add a custom field for a payment method in Magento 2 at the checkout step. Custom field allows buyers to enter a phone for a payment method.","breadcrumb":{"@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#primaryimage","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2022\/06\/payment_method.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2022\/06\/payment_method.png","width":1528,"height":768,"caption":"payment_method"},{"@type":"BreadcrumbList","@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-field-for-a-payment-method-in-magento2\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webkul.com\/blog\/"},{"@type":"ListItem","position":2,"name":"How to add custom field for a payment method in Magento 2?"}]},{"@type":"WebSite","@id":"https:\/\/webkul.com\/blog\/#website","url":"https:\/\/webkul.com\/blog\/","name":"Webkul Blog","description":"","publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/webkul.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/webkul.com\/blog\/#organization","name":"WebKul Software Private Limited","url":"https:\/\/webkul.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","width":380,"height":380,"caption":"WebKul Software Private Limited"},"image":{"@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/webkul\/","https:\/\/x.com\/webkul","https:\/\/www.instagram.com\/webkul\/","https:\/\/www.linkedin.com\/company\/webkul","https:\/\/www.youtube.com\/user\/webkul\/"]},{"@type":"Person","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/1bfed7985110d44a908d093a4e322727","name":"Radhika Garg","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/2319613aaa0bc878e7855f009fc5a889134810d78fa0d1e693180b36f82156a3?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/2319613aaa0bc878e7855f009fc5a889134810d78fa0d1e693180b36f82156a3?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","caption":"Radhika Garg"},"url":"https:\/\/webkul.com\/blog\/author\/radhika-garg178\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/339766","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/users\/375"}],"replies":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/comments?post=339766"}],"version-history":[{"count":7,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/339766\/revisions"}],"predecessor-version":[{"id":380678,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/339766\/revisions\/380678"}],"wp:attachment":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media?parent=339766"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/categories?post=339766"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/tags?post=339766"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}