![\"payment-extensio-folder-structure\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/06\/payment-extensio-folder-structure.png\")
<\/figure>\n\n\n\nPayment extension backend code<\/h2>\n\n\n\n
Finally, we have our folder structure in place, let\u2019s start creating an extension, we will show \u201dWebkul Payment\u201d on the checkout page.<\/p>\n\n\n\n
admin\/controller\/payment\/example_payment.php<\/strong><\/p>\n\n\n\n admin\/language\/en-gb\/payment\/example_payment.php<\/strong><\/p>\n\n\n\n admin\/view\/template\/payment\/example_payment.twig<\/strong><\/p>\n\n\n\n Now, let\u2019s initiate the development of the frontend code to display the payment methods on the checkout page.<\/p>\n\n\n\n catalog\/controller\/payment\/example_payment.php<\/strong><\/p>\n\n\n\n catalog\/model\/payment\/example_payment.php<\/strong><\/p>\n\n\n\n catalog\/language\/en-gb\/payment\/example_payment.php<\/strong><\/p>\n\n\n\n catalog\/view\/template\/payment\/example_payment.twig<\/strong><\/p>\n\n\n\n Once you have created the extension, you will need to include some information within the module\u2019s \u201cinstall.json\u201d file. This file supports the following keys: name, version, author, and link.<\/p>\n\n\n\n Once install.json is inside the directory, you can zip it and name it that ends with .ocmod.zip, then upload it from the Opencart extension installer.<\/p>\n\n\n\n Upon successful installation of the extension, you can locate it by navigating to “Extensions > Extensions > Payment” where it will be listed for further configuration and customization.<\/p>\n\n\n\n Once the configuration is complete, the “Webkul Payment” payment method will become visible on the checkout page for you to select and proceed with your order.<\/p>\n\n\n\n These instructions will guide you through the process of creating a payment module for Opencart<\/p>\n\n\n\n If you need custom Opencart Development services<\/a> then feel free to reach us<\/a> and also explore our exclusive range of Opencart Addons<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"<?php\n \/**\n * Extension name: Webkul Payment\n * Descrption: Using this extension we will show payment methods on the checkout page.\n * Author: Webkul Software Pvt. Ltd. \n * \n *\/\nnamespace Opencart\\Admin\\Controller\\Extension\\ExamplePayment\\Payment;\n\nclass ExamplePayment extends \\Opencart\\System\\Engine\\Controller {\n \n \/**\n * index\n *\n * @return void\n *\/\n public function index(): void {\n \n $this->load->language('extension\/example_payment\/payment\/example_payment');\n\n $this->document->setTitle($this->language->get('heading_title'));\n\n $data['breadcrumbs'] = [];\n\n $data['breadcrumbs'][] = [\n 'text' => $this->language->get('text_home'),\n 'href' => $this->url->link('common\/dashboard', 'user_token=' . $this->session->data['user_token'])\n ];\n\n $data['breadcrumbs'][] = [\n 'text' => $this->language->get('text_extension'),\n 'href' => $this->url->link('marketplace\/extension', 'user_token=' . $this->session->data['user_token'] . '&type=payment')\n ];\n\n if (!isset($this->request->get['module_id'])) {\n $data['breadcrumbs'][] = [\n 'text' => $this->language->get('heading_title'),\n 'href' => $this->url->link('extension\/example_payment\/payment\/example_payment', 'user_token=' . $this->session->data['user_token'])\n ];\n } else {\n $data['breadcrumbs'][] = [\n 'text' => $this->language->get('heading_title'),\n 'href' => $this->url->link('extension\/example_payment\/payment\/example_payment', 'user_token=' . $this->session->data['user_token'] . '&module_id=' . $this->request->get['module_id'])\n ];\n }\n\n $data['save'] = $this->url->link('extension\/example_payment\/payment\/example_payment.save', 'user_token=' . $this->session->data['user_token']);\n $data['back'] = $this->url->link('marketplace\/extension', 'user_token=' . $this->session->data['user_token'] . '&type=payment');\n\n \/\/ getting payment extension config\n $data['payment_example_payment_order_status_id'] = $this->config->get('payment_example_payment_order_status_id');\n\n \/\/ loading order status model\n\t\t$this->load->model('localisation\/order_status');\n\n \/\/ getting order status as array\n\t\t$data['order_statuses'] = $this->model_localisation_order_status->getOrderStatuses();\n\n \/\/ zeo zone id\n\t\t$data['payment_example_payment_geo_zone_id'] = $this->config->get('payment_example_payment_geo_zone_id');\n\n \/\/ loading geo_zone model\n\t\t$this->load->model('localisation\/geo_zone');\n\n \/\/ getting all zeo zones\n\t\t$data['geo_zones'] = $this->model_localisation_geo_zone->getGeoZones();\n \n\t\t$data['payment_example_payment_status'] = $this->config->get('payment_example_payment_status');\n\t\t$data['payment_example_payment_sort_order'] = $this->config->get('payment_example_payment_sort_order');\n\n $data['header'] = $this->load->controller('common\/header');\n $data['column_left'] = $this->load->controller('common\/column_left');\n $data['footer'] = $this->load->controller('common\/footer');\n\n $this->response->setOutput($this->load->view('extension\/example_payment\/payment\/example_payment', $data));\n }\n \n \/**\n * save method\n *\n * @return void\n *\/\n public function save(): void {\n \/\/ loading example payment language\n $this->load->language('extension\/example_payment\/payment\/example_payment');\n\n $json = [];\n\n \/\/ checking file modification permission\n if (!$this->user->hasPermission('modify', 'extension\/example_payment\/payment\/example_payment')) {\n $json['error']['warning'] = $this->language->get('error_permission');\n }\n\n if (!$json) {\n $this->load->model('setting\/setting');\n\n $this->model_setting_setting->editSetting('payment_example_payment', $this->request->post);\n\n $json['success'] = $this->language->get('text_success');\n }\n\n $this->response->addHeader('Content-Type: application\/json');\n $this->response->setOutput(json_encode($json));\n }\n\n}<\/pre>\n\n\n\n<?php\n\/**\n * Webkul Software\n * \n * @category Webkul\n * @package Opencart Payment Tutorial\n * @author [Webkul] <[<http:\/\/webkul.com\/>]>\n * @copyright Copyright (c) Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\n\/\/ Heading\n$_['heading_title'] = 'Webkul Payment';\n\n\/\/ Text\n$_['text_extension'] = 'Extensions';\n$_['text_success'] = 'Success: You have modified Webkul Payment payment module!';\n$_['text_edit'] = 'Edit Webkul Payment';\n\n\/\/ Entry\n$_['entry_order_status'] = 'Order Status';\n$_['entry_geo_zone'] = 'Geo Zone';\n$_['entry_status'] = 'Status';\n$_['entry_sort_order'] = 'Sort Order';\n\n\/\/ Error\n$_['error_permission'] = 'Warning: You do not have permission to modify payment Webkul Payment!';<\/pre>\n\n\n\n
{{ header }}{{ column_left }}\n<div id="content">\n <div class="page-header">\n <div class="container-fluid">\n <div class="float-end">\n <button type="submit" form="form-payment" data-bs-toggle="tooltip" title="{{ button_save }}" class="btn btn-primary"><i class="fa-solid fa-save"><\/i><\/button>\n <a href="{{ back }}" data-bs-toggle="tooltip" title="{{ button_back }}" class="btn btn-light"><i class="fa-solid fa-reply"><\/i><\/a><\/div>\n <h1>{{ heading_title }}<\/h1>\n <ol class="breadcrumb">\n {% for breadcrumb in breadcrumbs %}\n <li class="breadcrumb-item"><a href="{{ breadcrumb.href }}">{{ breadcrumb.text }}<\/a><\/li>\n {% endfor %}\n <\/ol>\n <\/div>\n <\/div>\n <div class="container-fluid">\n <div class="card">\n <div class="card-header"><i class="fa-solid fa-pencil"><\/i> {{ text_edit }}<\/div>\n <div class="card-body">\n <form id="form-payment" action="{{ save }}" method="post" data-oc-toggle="ajax">\n <div class="row mb-3">\n <label for="input-order-status" class="col-sm-2 col-form-label">{{ entry_order_status }}<\/label>\n <div class="col-sm-10">\n <select name="payment_example_payment_order_status_id" id="input-order-status" class="form-select">\n {% for order_status in order_statuses %}\n <option value="{{ order_status.order_status_id }}"{% if order_status.order_status_id == payment_example_payment_order_status_id %} selected{% endif %}>{{ order_status.name }}<\/option>\n {% endfor %}\n <\/select>\n <\/div>\n <\/div>\n <div class="row mb-3">\n <label for="input-geo-zone" class="col-sm-2 col-form-label">{{ entry_geo_zone }}<\/label>\n <div class="col-sm-10">\n <select name="payment_example_payment_geo_zone_id" id="input-geo-zone" class="form-select">\n <option value="0">{{ text_all_zones }}<\/option>\n {% for geo_zone in geo_zones %}\n <option value="{{ geo_zone.geo_zone_id }}"{% if geo_zone.geo_zone_id == payment_example_payment_geo_zone_id %} selected{% endif %}>{{ geo_zone.name }}<\/option>\n {% endfor %}\n <\/select>\n <\/div>\n <\/div>\n <div class="row mb-3">\n <label for="input-status" class="col-sm-2 col-form-label">{{ entry_status }}<\/label>\n <div class="col-sm-10">\n <div class="form-check form-switch form-switch-lg">\n <input type="hidden" name="payment_example_payment_status" value="0"\/>\n <input type="checkbox" name="payment_example_payment_status" value="1" id="input-status" class="form-check-input"{% if payment_example_payment_status %} checked{% endif %}\/>\n <\/div>\n <\/div>\n <\/div>\n <div class="row mb-3">\n <label for="input-sort-order" class="col-sm-2 col-form-label">{{ entry_sort_order }}<\/label>\n <div class="col-sm-10">\n <input type="text" name="payment_example_payment_sort_order" value="{{ payment_example_payment_sort_order }}" placeholder="{{ entry_sort_order }}" id="input-sort-order" class="form-control"\/>\n <\/div>\n <\/div>\n <\/form>\n <\/div>\n <\/div>\n <\/div>\n<\/div>\n{{ footer }}<\/pre>\n\n\n\nFrontend code<\/h2>\n\n\n\n
<?php\n\/**\n * Extension name: Webkul Payment\n * Descrption: Using this extension we will show payment methods on the checkout page.\n * Author: Webkul Software Pvt. Ltd. \n * \n *\/\nnamespace Opencart\\Catalog\\Controller\\Extension\\ExamplePayment\\Payment;\n\nclass ExamplePayment extends \\Opencart\\System\\Engine\\Controller\n{ \n \/**\n * index\n *\n * @return mix\n *\/\n public function index(): string\n { \n \/\/ loading example payment language\n $this->load->language('extension\/example_payment\/payment\/example_payment');\n\n $data['language'] = $this->config->get('config_language');\n\n return $this->load->view('extension\/example_payment\/payment\/example_payment', $data);\n }\n \n \/**\n * confirm\n *\n * @return json|string\n *\/\n public function confirm(): void\n {\n \/\/ loading example payment language\n $this->load->language('extension\/example_payment\/payment\/example_payment');\n\n $json = [];\n\n if (!isset($this->session->data['order_id'])) {\n $json['error'] = $this->language->get('error_order');\n }\n \n if (!isset($this->session->data['payment_method']) || $this->session->data['payment_method']['code'] != 'example_payment.example_payment') {\n $json['error'] = $this->language->get('error_payment_method');\n }\n\n if (!$json) {\n $this->load->model('checkout\/order');\n\n $this->model_checkout_order->addHistory($this->session->data['order_id'], $this->config->get('payment_example_payment_order_status_id'));\n\n $json['redirect'] = $this->url->link('checkout\/success', 'language=' . $this->config->get('config_language'), true);\n }\n\n $this->response->addHeader('Content-Type: application\/json');\n $this->response->setOutput(json_encode($json));\n }\n}<\/pre>\n\n\n\n<?php\n\/**\n * Extension name: Webkul Payment\n * Descrption: Using this extension we will show payment methods on the checkout page.\n * Author: Webkul Software Pvt. Ltd. \n * \n *\/\nnamespace Opencart\\Catalog\\Model\\Extension\\ExamplePayment\\Payment;\n\nclass ExamplePayment extends \\Opencart\\System\\Engine\\Model {\n \t\n\t\/**\n\t * getMethods\n\t *\n\t * @param mixed $address\n\t * @return array\n\t *\/\n\tpublic function getMethods(array $address = []): array {\n\n \/\/ loading example payment language\n\t\t$this->load->language('extension\/example_payment\/payment\/example_payment');\n\n\t\tif ($this->cart->hasSubscription()) {\n\t\t\t$status = false;\n\t\t} elseif (!$this->cart->hasShipping()) {\n\t\t\t$status = false;\n\t\t} elseif (!$this->config->get('config_checkout_payment_address')) {\n\t\t\t$status = true;\n\t\t} elseif (!$this->config->get('payment_example_payment_geo_zone_id')) {\n\t\t\t$status = true;\n\t\t} else {\n \/\/ getting payment data using zeo zone\n\t\t\t$query = $this->db->query("SELECT * FROM `" . DB_PREFIX . "zone_to_geo_zone` WHERE `geo_zone_id` = '" . (int)$this->config->get('payment_example_payment_geo_zone_id') . "' AND `country_id` = '" . (int)$address['country_id'] . "' AND (`zone_id` = '" . (int)$address['zone_id'] . "' OR `zone_id` = '0')");\n\n \/\/ if the rows found the status set to True\n\t\t\tif ($query->num_rows) {\n\t\t\t\t$status = true;\n\t\t\t} else {\n\t\t\t\t$status = false;\n\t\t\t}\n\t\t}\n\n\t\t$method_data = [];\n \n\t\tif ($status) {\n\t\t\t$option_data['example_payment'] = [\n\t\t\t\t'code' => 'example_payment.example_payment',\n\t\t\t\t'name' => $this->language->get('heading_title')\n\t\t\t];\n\n\t\t\t$method_data = [\n\t\t\t\t'code' => 'example_payment',\n\t\t\t\t'name' => $this->language->get('heading_title'),\n\t\t\t\t'option' => $option_data,\n\t\t\t\t'sort_order' => $this->config->get('payment_example_payment_sort_order')\n\t\t\t];\n\t\t}\n\n\t\treturn $method_data;\n\t}\n}<\/pre>\n\n\n\n<?php\n\/**\n * Webkul Software\n * \n * @category Webkul\n * @package Opencart Payment Tutorial\n * @author [Webkul] <[<http:\/\/webkul.com\/>]>\n * @copyright Copyright (c) Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\n\/\/ Heading\n$_['heading_title'] = 'Webkul Payment';\n\n\/\/ Error\n$_['error_order_id'] = 'No order ID in the session!';\n$_['error_payment_method'] = 'Payment method is incorrect!';<\/pre>\n\n\n\n
<div class="text-end">\n <button type="button" id="button-confirm" class="btn btn-primary">{{ button_confirm }}<\/button>\n<\/div>\n<script type="text\/javascript"><!--\n$('#button-confirm').on('click', function () {\n var element = this;\n\n $.ajax({\n url: 'index.php?route=extension\/example_payment\/payment\/example_payment.confirm&language={{ language }}',\n dataType: 'json',\n beforeSend: function () {\n $(element).button('loading');\n },\n complete: function () {\n $(element).button('reset');\n },\n success: function (json) {\n if (json['error']) {\n $('#alert').prepend('<div class="alert alert-danger alert-dismissible"><i class="fa-solid fa-circle-exclamation"><\/i> ' + json['error'] + ' <button type="button" class="btn-close" data-bs-dismiss="alert"><\/button><\/div>');\n }\n\n if (json['redirect']) {\n location = json['redirect'];\n }\n },\n error: function (xhr, ajaxOptions, thrownError) {\n console.log(thrownError + "\\r\\n" + xhr.statusText + "\\r\\n" + xhr.responseText);\n }\n });\n});\n\/\/--><\/script><\/pre>\n\n\n\n{\n "name": "Webkul Payment Extension",\n "version": "1.0",\n "author": "Webkul Software Pvt. Ltd.",\n "link": "https:\/\/www.webkul.com",\n "instruction": ""\n}<\/pre>\n\n\n\n![\"payment](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/06\/payment-installer-15.png\")
<\/figure>\n\n\n\n![\"Extensions-1-1\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/06\/Extensions-1-1-1177x1024.png\")
<\/figure>\n\n\n\n![\"extension-configure\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/06\/extension-configure.png\")
<\/figure>\n\n\n\n![\"payment-checkout-1\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/06\/payment-checkout-1-1200x601.png\")
<\/figure>\n\n\n\n