{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-modules/magento/magento_module.yaml","sidebar":"sidebar-sidebar.yaml__modules_magento_magento_module"},"props":{"definitionId":"modules/magento/magento_module.yaml","dynamicMarkdocComponents":[],"baseSlug":"/modules/magento/magento_module","seo":{"title":"Magento Extension Guide","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Magento Extension Guide","description":"\nPlugin version 3.5.0, 15.06.2026\n\nHere at Simplie we strive to help our partners sell more by simplifying purchases and making financing more accessible to customers. For exactly this reason we offer a number of buy-now-pay-later (BNPL) solutions. Our most known credit offering is hire-purchase, also known as payment by installments.\n\nThe Simplie e-commerce extension for Magento connects partner e-shops with our e-POS solution. With Simplie e-POS, partners only need to add Simplie as a payment method and Simplie will take care of all the rest. Customers are redirected to the e-POS environment to complete the financing of the purchase. After a successful financing process we redirect the customer back to you.\n\nSimplie e-POS is supplemented with Simplie Partner Portal where merchants can see the overview of submitted credit applications, create applications for customers and conduct contract withdrawals.\n\nIf you have any questions regarding the Simplie Magento extension, just contact us and we will be happy to help:\n\n- Estonia - integration@inbank.ee\n- Poland - integration@inbank.pl\n- Latvia - integration@inbank.lv\n- Czech Republic - integration@inbank.cz\n- Lithuania - integration@inbank.lt\n\nThe Pay Later Platform by Simplie supports Magento 2.4.x versions.\n\nThe Simplie e-commerce extension for Magento gives merchants access to the following Simplie products:\n\nYou can find the list of available Simplie products [here](#listofproducts).\n\n# Changelog\n\n|**Version**|**Date**|**Updates**|\n| :- | :- |:- |\n| 3.0.1 | 09.12.2024 | Added Simplie Hire Purchase Lithuania payment product.|\n| 3.0.2 | 06.06.2025 | Updated LT calculation logic.|\n| 3.1.0 | 17.06.2025 | Added Simplie Moki Lithuania payment product.|\n| 3.2.1 | 06.08.2025 | Added Simplie HP Flex product for EE and LV.|\n| 3.2.2 | 13.08.2025 | The invoice should be generated after the order is verified on the ePOS return.|\n| 3.2.3 | 27.08.2025 | Fixed product save action in admin. |\n| 3.2.4 | 18.09.2025 | Added Changes to Moki1 product.|\n| 3.3.0 | 22.09.2025 | Added Simplie HP Flex product for PL.|\n| 3.4.1 | 01.10.2025 | Removed Simplie Pay next month product.|\n| 3.4.4 | 31.10.2025 | Bugfixes.|\n| 3.4.6 | 05.11.2025 | General calculator enabler. Fixed version control initiation.|\n| 3.4.7 | 23.01.2026 | HP LV calculator and cehckout information fixes.|\n| 3.4.9 | 13.02.2026 | HP LT validation fixes. Removed from POS session request redundant key.|\n| 3.5.0 | 15.06.2026 | Bugfixes.|\n\n# Installation\n\nYou can download the latest version of the extension from here:\n\n - version 3.4.6 - build compatible with Magento 2.4.4-2.4.7 and PHP 8.1-8.3\n - version 2.0.3 - build compatible with Magento 2.4.2-2.4.7 and PHP 7.4-8.2\n - version 2.0.3 - build compatible with Magento 2.4.2 and PHP 7.3\n\nTo install the Simplie e-commerce extension you just need to follow these steps:\n\n1. Copy the extension folder into `the/app/code/directory`.\n2. Enable the extension using the following command:\n ```php\n php bin/magento --clear-static-content module:enable Inbank_InbankPayment\n ```\n\n3. Upgrade the database by running:\n ```php\n php bin/magento setup:upgrade\n ```\n\n4. If you are in live mode, you also need to compile and deploy by running the following commands:\n ```php\n php bin/magento setup:di:compile\n php bin/magento setup:static-content:deploy\n ```\n\n5. As the last step, clear the cache by running:\n ```php\n php bin/magento cache:flush\n ```\n\n# Enable Simplie Payment Methods\n\nAfter successful installation of the Pay Later Platform by Simplie, you can enable Simplie payments and configure Simplie products as payment methods in your back office.\n\nThe very first step is enabling Simplie payment in your system which is done at Stores > Settings > Configuration > Sales > Payment Methods.\n\nThe Other Payments Methods section will list InbankPayments as an option, click on it to expand the settings.\n\nTo enable Simplie payments in your store, set the Enabled parameter to `Yes`.\n\n

\n\n

\n\nFurther configuration can be accessed by clicking the Simplie Settings button, you can find detailed information in the [Extension Overview Page](#extensionoverview) and [Adding New Payment Options](#addingnewpayment) sections.\n\nHere you can also customize which statuses the extension sets for:\n\n- Confirmed order state - for cases when the purchase was successfully financed by Simplie\n- Pending order state - for cases when the purchase is awaiting financing by Simplie\n- Granted order state - for cases when the credit was granted by Simplie, and contract activation awaits partner approval\n- Canceled order state - for cases when the credit has been canceled\n\n**Note:** Simplie communicates financing status changes to the online store through callbacks, allowing the plugin to update order statuses accordingly.
\nIf order statuses are not updating as expected, verify that Simplie's callback IP addresses are whitelisted in your firewall or network security settings. See [Callback IP Whitelisting](/api/additional-api-flow/section/callback-ip-whitelisting) for the required IP addresses.\n\n\n\n\n\n# Extension Overview Page\n\nAfter successful installation of the Pay Later Platform by Simplie, you can configure Simplie products as payment methods in your back office.\n\nPay Later Platform configuration is done at Stores > Settings > Simplie.\n\nThe extension includes the following Simplie payment methods:\n- Simplie Hire Purchase (Estonia, Latvia, Poland, Czech Republic, Lithuania)\n- Simplie Split into parts (Estonia, Latvia)\n- Simplie Green Energy (Czech Republic)\n- Simplie Moki (Lithuania)\n- Simplie HP Flex (Estonia, Latvia, Poland)\n\nThe extension overview page at Stores > Settings > Simplie includes the list of all the Simplie payment options added.\n\n

\n\n

\n\nHere several actions regarding added payment options are available:\n- Click the Status icon next to a payment option to enable/disable it.\n

\n\n

\n\n- Click Edit next to a payment option to make changes yto it's configuration.\n

\n\n

\n\n- Click the dropdown button next to a payment option to enable/disable or delete it.\n

\n\n

\n\n\n\n# Adding New Payment Options\n\nNew payment options are added via clicking the Add payment option at Stores > Settings > Simplie.\n\nDepending on the Simplie branch(es) you are cooperating with, you need to configure the payment products for Estonia, Poland, Czechia, Latvia or Lithuania. You can offer one of the available products or several, depending on the agreement you have with Simplie.\n\nThe following configuration parameters are predefined by Simplie:\n\n - Title\n - Maximum order amount\n - Minimum order amount\n - Period\n - Additional details\n\nNote that the predefined values will be updated if they change on the Simplie side. The exceptions are the Title and Additional details values which are customizable. The Title and Additional details are updated if set to default, but are not updated if they have been customized.\n\nFor more information on updates, refer to the [Updates](#updates) section.\n\nAdding a new Simplie payment method to the extension configuration is a simple two-step process.\n\nOn step 1 you need to set the keys and product code required for the functioning of the extension and the mode in which this payment product is to be available: live or test.\n\nSimplie representatives will provide you all the data required for this step. Make sure to fill in all the fields correctly, as they are essential to the configuration of Simplie payment products.\n\nOn step 2 you can review your configuration and set a couple additional options available in the extension.\n\n## Step 1: Settings\n\nTo start adding a new Simplie payment product, click Add payment option at Stores > Settings > Simplie.\nConfiguration settings are similar for all payment products: Simplie Hire Purchase Estonia, Simplie Split into parts Estonia, Simplie HP Flex Estonia, Simplie Hire Purchase Poland, Simplie HP Flex Poland, Simplie Hire Purchase Czech Republic, Simplie Green Energy Czech Republic, Simplie Hire Purchase Latvia, Simplie HP Flex Latvia, Simplie Hire Purchase Lithuania and Simplie Moki Lithuania.\n\nThe product code set during configuration defines the credit conditions available to customers and also automatically sets the following parameters:\n\n - Title\n - Minimum order amount\n - Maximum order amount\n - Period\n - Additional details\n\nStep 1 includes the essential parameters needed for the payment option setup. Simplie representatives will provide you all the information needed at this step. After you add the necessary data, click Next to proceed to step 2 where you review the configuration and can set a number of additional parameters for the payment option.\n\n

\n\n

\n\n|**Field**|**Description**|\n| :- | :- |\n| Country | The market for which you wish to add an Simplie payment method.
Available options: Estonia, Poland, Latvia, Czech Republic, Lithuania.|\n| Product | The payment product you wish to add. The section depends on the Country:

- Simplie Hire Purchase (Estonia, Latvia, Poland, Czech Republic, Lithuania)
- Simplie HP Flex (Estonia, Latvia, Poland)
- Simplie Split into parts (Estonia, Latvia)
- Simplie Green Energy (Czech Republic)
- Simplie Moki (Lithuania) |\n| Live product code / Test product code | The product code provided by Simplie. This code defines the credit conditions offered at checkout.|\n| Enable test mode | Select whether the extension should be connected to test API for testing purposes. If this parameter is not enabled, the extension connects to the live API.

This parameter defines whether next you need to set the API key, UUID and product code for the live or test environment.

By default, test mode is disabled, but the setting can be customized.|\n| Live API key / Test API key | The unique key of the shop used for building API requests through which the shop communicates with Simplie.|\n| Live shop UUID / Test shop UUID | The API authentication key. The API key should be kept private.|\n| Localization ID | ID of the set of translations required for the extension. Translations are available in Estonian, Polish, English, Latvian, Czech, Russian and Lithuanian.|\n| Localization token | Token required to access the translations for storefront texts.|\n\n## Step 2: Overview and Confirmation\n\nStep 2 lets you review the payment option configuration and includes a number of additional parameters which can be configured for Simplie payment methods.\n\n

\n\n

\n\n|**Field**|**Description**|\n| :- | :- |\n| Enable product | Whether this Simplie product appears as a payment method at checkout.|\n| Enable test mode | Select whether the extension should be connected to test API for testing purposes. If the parameter is not enabled, the extension connects to the live API.

This parameter defines whether next you need to set the API key, UUID and product code for the live or test environment.|\n| Live product code/Test product code | The product code provided by Simplie. This code defines the credit conditions offered at checkout.

This parameter is prefilled from Step 1 , but you can change the Product Code here if needed.|\n| Live API key / Test API key | The unique key of the shop used for building API requests through which the shop communicates with Simplie.

This parameter is prefilled from Step 1 , but you can change the API key here if needed.|\n| Live shop UUID / Test shop UUID| The API authentication key. The API key should be kept private.

This parameter is prefilled from Step 1 , but you can change the UUID here if needed.|\n| Localization ID | ID of the set of translations required for the extension. Translations are available in Estonian, Polish, English, Latvian, Czech, Russian and Lithuanian.

This parameter is prefilled from Step 1 , but you can change the Localization ID here if needed.|\n| Localization token | Token required to access the translations for storefront texts.

This parameter is prefilled from Step 1 , but you can change the Localization token here if needed.|\n| Display logo | Whether the payment method logo will be displayed next to the title at checkout.

By default the logo is enabled, but the setting can be customized.|\n| Custom logo | A custom logo for the payment method which will be displayed next to the title at checkout. If the custom logo is removed, the default logo will be applied. |\n| Logo size | The size of the payment method logo which is displayed next to the title at checkout. The logo will be displayed only if the Use Logo parameter is set to Yes.
Available size options are Small and Medium.

The default value is Small, but the setting can be customized.|\n| Enable calculations | Whether calculated monthly amounts should be presented on product pages. When enabled, preliminary calculations of monthly payments will appear on the pages of products within the minimum-maximum range for this Product code.

Calculations are available for Simplie Hire Purchase Estonia, Simplie HP Flex Estonia, Simplie Hire Purchase Poland, Simplie HP Flex Poland, Simplie Hire Purchase Czech Republic, Simplie Hire Purchase Latvia, Simplie HP Flex Latvia, Simplie Hire Purchase Lithuania and Simplie Moki Lithuania payment products only.|\n| Calculation position | The exact place where the Simplie monthly payment calculation will be displayed. Available options:
- After product price
- After add to cart
- In extrahint block|\n| Title | The payment method title that is displayed to customers at checkout. The recommended Title length is 65 characters.

The default Title is defined by the Product code. You can customize it for Simplie Hire Purchase Estonia, Simplie HP Flex Estonia, Simplie Hire Purchase Poland, Simplie HP Flex Poland, Simplie Hire Purchase Czech Republic, Simplie Hire Purchase Latvia, Simplie HP Flex Latvia, Simplie Hire Purchase Lithuania and Simplie Moki Lithuania products, in which case the default value will be displayed under the Title field. If you set a different Product code, your custom value will be overridden with the new default one, which can then be customized.|\n| Minimum Order Amount | The minimum order amount for which the payment method is available. The value is defined by the product code.

For sums below this value, the payment method is not displayed.|\n| Maximum Order Amount | The maximum order amount for which the payment method is available. The value is defined by the product code.

For sums above this value, the payment method is not displayed.|\n| Period | The period options in months for which credit under this payment method is granted. The values are defined by the product code.|\n| Additional details | The consent message displayed under the payment method at checkout. The default Additional details are defined by the Product code. You can customize it, then the default value will be displayed under the Additional details field.|\n| Payment in Websites | If you have multiple stores configured in your Magento instance, you can select in which stores exactly the payment method will be available.|\n| Payment in Store | If you have payment methods configured for different stores in your Magento instance, you can select the market for which payment methods will be presented on the product page.|\n\n# Testing\n\nSimplie provides a dedicated staging environment for testing the integration with payment solutions\nFor testing purposes, you need to specify several parameters in the payment methods settings at Stores > Settings > Simplie. When adding a new payment option you need to:\n- Switch on the Enable test mode parameter\n- Specify the Test API key\n- Specify the Test shop UUID\n- Specify the Test product code\n\nThe Test API key, Test shop UUID and Test product code are provided by Simplie.\n\nFor testing purposes, the system will return preconfigured decisions:\n- For Simplie Hire Purchase Estonia, Simplie Split into parts Estonia, Simplie HP Flex Estonia, Simplie Hire Purchase Latvia, Simplie HP Flex Latvia, Simplie Hire Purchase Lithuania, Simplie Moki Lithuania, Simplie Split into parts Latvia, Simplie Hire Purchase Czech Republic, Simplie Green Energy Czech Republic, Simplie HP Flex Poland and Simplie Hire Purchase Poland payment products, positive decisions are given for amounts 0 - 500, 15 000 - 16 000.\n\nThe credit application process may include an OTP code exchange via SMS. The demo environments do not send out SMS messages. If you are testing Split into parts payment products, the SMS message is hardcoded to value 0000.\n\nTesting Simplie Payments Estonia products\n\nTo test the financing products in Estonia, you can safely use your own Estonian ID-code and ID-card, as the demo environment does not initiate real binding contracts. Alternatively, you can use our demo user, the identity code of which is 10101010005. Besides the identity code, you will also need a name and a unique phone number for authentication and signing.\n\nTo use an ID-card or Mobile-ID in the demo environment, you need to register them at:\n- ID-card - https://demo.sk.ee/upload_cert/.\n- Mobile-ID - https://demo.sk.ee/MIDCertsReg/.\n\nYou can also use Smart-ID by downloading the following apps:\n- Android: https://play.google.com/apps/testing/com.stagnationlab.sk.\n- iOS: https://testflight.apple.com/join/DoWddZjR.\n\nTo use Smart-ID for testing, your account level should be `Qualified`. You can check the account level at https://sid.demo.sk.ee/portal/login.\n\n\n\n# Updates\n\nThere are a couple of things which can be updated in the Pay Later Platform\n\n- [Extension updates](#extensionupdates). The current version of the extension contains all the functionality required to offer Simplie payment methods to customers. In the future we plan on adding new payment products to the extension, as well as features to improve existing functionality. Updating the extension to the latest version will support added features and keep your store up to date with the latest enhancements from Simplie to make purchases even smoother for your customers.

\n\n- [API data updates](#apidataupdates). The extension retrieves data from Simplie regarding the conditions of payment products offered to customers. This data can undergo changes on the Simplie side. If such changes occur, product parameters should also be updated in the extension, for the customers to successfully use Simplie payment methods.

\n\n- [Extension settings updates](#extensionsettingsupdates). The payment product which is offered to customers depends on the product code set for the payment method. If at any point you need to change the product code or any other extension configurations, this can be easily done through the extension settings.\n\n\n\n## Extension Update\n\nIf a new version of the Simplie extension for Magento comes out and you want to make use of the functionality it offers, updating the extension is quick and easy. Do not worry about the configuration settings. While the extension is updated, all settings, including API keys, product codes, etc., are migrated into the new version of the extension.\n\n1. Download the.zip package containing the new version of the extension from here:\n\n - version 3.0.0 - build compatible with Magento 2.4.4-2.4.7 and PHP 8.1-8.3\n - version 2.0.3 - build compatible with Magento 2.4.2-2.4.7 and PHP 7.4-8.2\n - version 2.0.3 - build compatible with Magento 2.4.2 and PHP 7.3\n\n2. Unpack the files and copy them to the root folder of your Magento installation.

\n\n3. Enable the extension using the following command:\n ```php\n php bin/magento --clear-static-content module:enable Inbank_InbankPayment\n ```\n\n4. Upgrade the database by running:\n ```php\n php bin/magento setup:upgrade\n ```\n\n5. If you are in live mode, compile and deploy by running the following commands:\n ```php\n php bin/magento setup:di:compile\n php bin/magento setup:static-content:deploy\n ```\n\n6. Clear cache by running:\n ```php\n php bin/magento cache:flush\n ```\n\n\n\n## API Data Update\n\nAfter you set a product code for an Simplie payment method, the extension retrieves product related parameters via API from Simplie. Simplie can make changes to these data and the changes need to be synchronized with the settings of the extension. Of course, you do not need to keep track of the possible updates, the Simplie extension will check for updates and apply them to your store.\n\nConfiguration parameters which can receive updates:\n\n- Title\n- Minimum Order Amount\n- Maximum Order Amount\n- Period\n- Additional Details\n\nFor the API data to be updated automatically, please make sure that cron jobs are enabled in your store.\n\n\n\n## Extension Settings Update\n\nIf at any point you need to make changes to the extension settings, you can access the configuration at Stores > Settings > Simplie.\n\nTo update the settings for the Pay Later Platform click Edit next to the payment method you wish to update, make the required configuration changes and click Save.\n\nThat is it. Your module settings are now updated.\n\n# Storefront Flow\n\nThis section showcases how Simplie payment options work at checkout.\n\nNote that the following screenshots are only demonstrational. The actual way the Simplie payment solution appears in your Magento store depends on the extension settings, the Simplie branch with which you have concluded the contract, the theme and locale of your store.\n\n1. If enabled, Simplie monthly payment calculations appear on product pages.

\n\n

\n\n

\n\n2. Simplie products appear at checkout as available payment methods:\n\n

\n \n

\n\n3. Once customers choose Simplie products as their payment method, they are redirected to the Simplie e-POS environment. Here customers go through a number of dialogs to complete the financing of the purchase.

\n\n4. After completing the procedure in Simplie e-POS, customers are redirected back to the shop.\n\nIf the purchase has been financed by Simplie, the customer will be redirected to the page configured in your Magento instance as the payment success page. Otherwise, the customer will be redirected back to the cart where they can choose an alternative payment method.\n\nPayment transactions can be viewed in the Sales > Orders section of the admin panel.\n\nUntil the credit contract has been signed by the customer and approved by Simplie for financing, it remains in status Simplie: waiting for financing. Orders which have been successfully financed by Simplie receive status Simplie: purchase financed.\n\nIf the flow is configured to require merchant approval prior to concluding the credit contract, the order which has been approved by Simplie for financing receives status Simplie: credit granted. Action required. In this state the order awaits the merchant's approval or cancellation. If the merchant approves the contract, the order receives status Simplie:purchase financed. Contracts are approved and cancelled through the Simplie Partner Portal.\n\n

\n\n

\n\n

\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.simplie.gr","port":4000,"ipAddress":"216.73.216.98"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"feature/AG-65-test-simplie-setup"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/modules/magento/magento_module","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}