{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-modules/shopify/shopify_module.yaml","sidebar":"sidebar-sidebar.yaml__modules_shopify_shopify_module"},"props":{"definitionId":"modules/shopify/shopify_module.yaml","dynamicMarkdocComponents":[],"baseSlug":"/modules/shopify/shopify_module","seo":{"title":"Shopify App Guide","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Shopify App Guide","description":"\nDocumentation version 2.4.0, 20.11.2025\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 solutions.\n\nThe Pay Later Platform by Simplie connects partner e-shops with our e-POS solution. With 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.\nAfter 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\nPlease note, that only full refunds are possible through the app.\n\nIf you have any questions about Simplie Shopify app, 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\nPay Later Platform by Simplie includes storefront content translations for the following languages: Estonian, Polish, English, Russian, Latvian, Czech, Lithuanian.\n\nThe Pay Later Platform gives merchants access to the following Simplie products:\n\nYou can find the list of available Simplie products [here](#listofproducts).\n\n {% admonition type=\"info\" name=\"Recommendation\" %}\n We suggest merchants to switch to the Shopify Plus plan to keep transaction costs lower.\n {% /admonition %}\n\n# Installation and Activation\n\nFollow the steps below to install and start using the Pay Later Platform by Simplie:\n\nInstallation by link\n\n1. Go to https://app.inbank.eu/install.\n2. Enter the URL of the store in which you wish the Pay Later Platform by Simplie to be installed and click INSTALL.
**Please note**, that the URL that is to be used at this step is the default *store*.myshopify.com type URL, not the custom URL that your store might have.
You will then be redirected to the Simplie settings page.\n3. Click Add product, [fill in and save the product details](#addingnewpayment) which have been provided by your Simplie representative.\n4. Once you've added a product click Back to Shopify.\n5. Click Activate on the app page and that's it. You are now all set to offer Simplie payment solutions to your customers.\n\n
\nAlternative installation method\n\n**Note:** Installation by link is the recommended and most reliable way to install the Simplie Shopify app. The alternative method below is less reliable and may not work in all cases. We recommend using it only if installation by link is not possible.\n\n1. In your store admin panel go to the payment settings at Settings > Payments and click Add payment methods.\n2. Choose to Search by provider, and type in Simplie.\n3. Click on the Simplie app.\n4. On the page that loads click Activate > Connect. The app will then be installed in your store.\n5. Click Add product, fill in and save the product details which have been provided by your Simplie representative.\n6. Once you've added a product click Back to Shopify.\n7. Click Activate on the app page and that's it. You are now all set to offer Simplie payment solutions to your customers.\n\n
\n\n\n\n# App Overview Page\n\nAfter successful installation of the Pay Later Platform by Simplie, you can configure Simplie products as payment methods in your admin panel.\n\nPay Later Platform configuration is done at Settings > Payments > Simplie > Manage > Manage.\n\nThe app includes the following Simplie payment methods:\n- Simplie Hire Purchase Estonia\n- Split into parts Estonia\n- Simplie Hire Purchase Poland\n- Simplie Hire Purchase Latvia\n- Split into parts Latvia\n- Simplie Hire Purchase Czechia\n- Simplie Hire Purchase Lithuania\n- Simplie Moki Lithuania\n- Simplie HP Flex Estonia\n- Simplie HP Flex Latvia\n- Simplie HP Flex Poland\n\nThe app overview page at Settings > Payments > Simplie > Manage > Manage 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\n● Click the Status icon next to a payment option to enable/disable it.\n\n

\n\n

\n\n● Click Edit next to a payment option to make changes to its configuration.\n\n

\n\n

\n\n● Click Delete next to a payment option to remove it from the list.\n\n

\n\n

\n\n\n\n# Adding New Payment Options\n\nNew payment options are added via clicking the Add product at Settings > Payments > _Inbank_ > Manage > Manage.\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 app 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 app 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 app.\n\n## Step 1: Settings\n\nTo start adding a new Simplie payment product, click Add product at Settings > Payments > Simplie >\nManage > Manage.\n\nConfiguration settings are similar for all payment products: Simplie Hire Purchase Estonia, Split into parts Estonia, Simplie HP Flex Estonia, Simplie Hire Purchase Poland, Simplie HP Flex Poland, Simplie Hire Purchase Czechia, Simplie Hire Purchase Latvia, Split into parts Latvia, Simplie HP Flex Latvia, Simplie Hire Purchase Lithuania, 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- Maximum order amount\n- Minimum 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.\n\nAfter you add the necessary data, click Save. After this the product is already added to your store, but on step 2 you can review the configuration and 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, Czechia, Latvia, Lithuania.|\n| Product | The payment product you wish to add. The section depends on the Country:

- Estonia - Simplie Hire Purchase, Split into parts, Simplie HP Flex
- Poland - Simplie Hire Purchase, Simplie HP Flex
- Latvia - Simplie Hire Purchase, Split into parts, Simplie HP Flex
- Czechia - Simplie Hire Purchase
- Lithuania - Simplie Hire Purchase, Simplie Moki|\n| Mode | Select whether the app should be connected to the test API for testing purposes or the production 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 enabled, but the setting can be customized.|\n| Product code | The product code provided by Simplie. This code defines the credit conditions offered at checkout.|\n| API key | The unique key of the shop used for building API requests through which the shop communicates with Simplie.|\n| Shop UUID | The API authentication key. The API key should be kept private.|\n\n## Step 2: Overview\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| Credentials |\n| Product code | The product code provided by Simplie. This code defines the credit conditions offered at checkout.|\n| API key | The unique key of the shop used for building API requests through which the shop communicates with Simplie.|\n| Shop UUID | The API authentication key. The API key should be kept private.|\n| Other available payment product parameters| |\n| Name | The payment method title that is displayed to customers at the [Simplie payments page](#inbankpaymentspage).

The default Name 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 Czechia, Simplie Hire Purchase Latvia, Simplie HP Flex Latvia, Simplie Hire Purchase Lithuania and Simplie Moki Lithuania products. If you set a different Product code, your custom value will be overridden with the new default one, which can then be customized.|\n| Additional details | The consent message displayed under the payment method at checkout. The default Additional details are defined by the Product code, but can be customized.|\n| Enable/Disable | Whether this Simplie product should be available to customers as a payment option.|\n| Logo | A custom logo for the payment method which will be displayed next to the name. If the custom logo is removed, the default logo will be applied.|\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 available.|\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| 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 available.|\n| Enable calculation | Whether calculations of Simplie payment products should be presented on product pages. When enabled, the calculations will appear on the pages of products within the minimum-maximum range for this Product Code.

The exact calculation depends on the type of the product. For Hire Purchase products it is a preliminary calculation of monthly payments; for Split into parts it is the calculation of interest-free equal monthly payments.

Calculations are enabled by default in the Simplie settings and need to be added to the store theme. More information in [Adding Simplie Calculations to Storefront](#addingtostorefront).|\n\n\n\n# Adding Simplie Calculations to Storefront\n\nInformation related to product page calculations can be found at Settings > Payments > Simplie > Manage > Manage > Theme integration.\n\nIf your store theme supports Online Store 2.0, then Simplie calculations are automatically available with the Pay Later Platform in the theme editor on the product page. By default, calculations are enabled in the Simplie settings and just need to be added to the store theme.\n\nIf your store theme does not support Online Store 2.0, you can add the Simplie calculations manually using the code provided on the Theme integration page.\n\n

\n\n

\n\nThe Simplie Calculator block needs to be added in the theme of the product pages at Online Store > Themes > Customize > Products.\n\n

\n\n

\n\n# Testing\n\nSimplie provides a dedicated staging environment for testing the integration with payment solutions. For testing purposes, you need to specify several parameters in the payment method settings at Add product at Settings > Payments > Simplie > Manage > Manage.\n\nWhen adding a new payment option you need to:\n- Use the Test mode\n- Specify the Api key provided for the test environment\n- Specify the Shop uuid provided for the test environment\n- Specify the Product code provided for the test environment
\n\nThe Api key, Shop uuid and Product code are provided by Simplie.\n\nFor testing purposes, the system returns preconfigured decisions:\n- For Simplie Hire Purchase Estonia, Split into parts Estonia, Simplie HP Flex Estonia, Simplie Hire Purchase Poland, Simplie HP Flex Poland, Simplie Hire Purchase Czechia, Simplie Hire Purchase Latvia, Split into parts Latvia, Simplie HP Flex Latvia, Simplie Hire Purchase Lithuania and Simplie Moki Lithuania payment products, positive decision is 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 phone number for authentication and signing.\n\nTo use an ID-card in the demo environment, you need to register it at:\n\n- ID-card - https://demo.sk.ee/upload_cert/.\n\nYou can also use Smart-ID by downloading the following apps:\n\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- App updates. Your store always automatically has the latest version of the Pay Later Platform, so no need to bother about any app updates.\n\n- API data updates. After you set a product code for an Simplie payment method, the app 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 app. Of course, you do not need to keep track of the updates, the Pay Later Platform has a daily check for updates and applies them to your store.\n\n Configuration parameters which can receive updates:\n - Title\n - Maximum order amount\n - Minimum order amount\n - Period\n - Additional details\n

\n\n- Product settings updates. 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 product configuration, this can be easily done through the app settings at Settings > Payments > Simplie > Manage > Manage.\n\nTo update the settings for the Pay Later Platform, click Edit next to the payment method you wish to change, make the required configuration changes and click Save.\n\nThat is it. Your product settings are now updated.\n\n# Storefront Flow\n\nThis section showcases how Simplie payment methods work in the store.\n\nNote that the following screenshots are only demonstrational. The actual way the Simplie payment methods appear in your Shopify store depends on the storefront theme, Simplie settings, the Simplie branch with which you have concluded the contract and the locale of your store.\n\n1. If enabled and added to your theme, calculations for Simplie payment options appear on product pages.\n\n

\n\n

\n\n2. Simplie appears at checkout as an available payment method:\n\n

\n\n

\n\n3. Once customers choose Simplie as their payment method and click Complete order, they are redirected to the Simplie environment where they first choose the preferred Simplie payment product and then go through a number of dialogs to complete the financing of the purchase.\n\n

\n\n

\n\n4. After completing the procedure in Simplie environment, customers are redirected back to the shop.\n\nIf the purchase has been financed by Simplie, the customer will be redirected to the payment success page. Otherwise, the customer will be redirected back to the cart.\n\nPayment transactions can be viewed in the Orders section of the admin panel.\n\nOrders which have been successfully financed by Simplie receive the payment status Paid.\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 can fall into one of the two following scenarios:\n\n- If payments are collected manually, the status will be set to Authorized and this is a signal that payments can be manually collected before the authorization period expires. By starting the capture process from the admin panel in this case the partner approves the contract. If the partner does not want to approve the contract, the order needs to be canceled, which also cancels the Simplie contract.

\n\n- If the payments are collected automatically, the status will be set to Pending and the contract needs to be confirmed through the Simplie Partner Portal. After the approval, the status will be set to Paid.\n\n**Note:** Simplie communicates financing status changes to the online store through callbacks, allowing the plugin to update order statuses accordingly.\n\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"},"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/shopify/shopify_module","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}