Shopify

Do you have an e-shop on Shopify and don't know how to install the Comgate payment gateway? Here are some instructions that will make the installation easier for you. Just install our module via this link.

Multicurrency

Shopify currently only allows multi-currency sales when using Shopify Payments. If an offsite payment provider (e.g. Comgate) is used, the amount will always be displayed in the store's default currency when redirected to the payment gateway. While customers can view prices in different currencies during the shopping process, the actual payment only takes place in the default currency.

This technical limitation is based on Shopify's architecture and cannot currently be circumvented. The recommended multicurrency solution is to open a new store in the desired currency. Shopify itself mentions this as a suitable solution in its community help.

Stores with multiple domains

Shopify allows operating a single store on multiple domains simultaneously. Thanks to this, one e-shop can be available, for example, at www.obchod.cz, www.e-shop.com, www.der-laden.de, or www.il-negozio.it. All these domains point to a single store, so product, pricing, and order management are handled centrally. In the same way, multiple domains can be used within one country (e.g., www.obchod.cz and www.prodej.cz).

Let’s explain what this means exactly and how it affects the configuration of the Comgate payment plugin.

Shopify handles domain routing centrally. Every store always runs under a default address in the format muj-obchod.myshopify.com. This domain cannot be removed or even changed. All additional domains are routed to it using aliases (CNAME records). The advantage of this solution is long-term stability – domain changes do not affect the operation of the store.

Comgate uses the default myshopify.com domain for payment integration, so you do not need to worry about any issues if you later adjust the mapping of your own domains (the Comgate payment gateway plugin is installed on the store, not on the domain).

Targeting different markets and multi-currency in a single store

If you operate one store for which you have set a dedicated national domain for each target market, the situation may become more complex when combined with multi-currency. If you use the same currency in all markets as the store’s primary currency, everything works without problems.

However, if for example you use CZK (the store’s primary currency) for .cz domains and EUR for a foreign market (for example the .de domain), everything will work until the moment the customer is redirected to the Comgate payment gateway.

Shopify does not allow true multi-currency for external payment services (outside Shopify Payments). In practice, this means that any currency other than the store’s primary currency will be automatically converted using Shopify’s internal exchange rate, and the payment through Comgate will be processed in this currency. The funds will then be paid out to you in the same currency.

More details can be found in the Multicurrency chapter.

Separate store for each target market

It is common to see an approach where a merchant creates multiple separate stores, each intended for a different target market. This model is easily recognizable because each store is managed in a separate administration and has its own invoicing. In such a case, the Comgate payment gateway plugin must be installed on each store separately, and each of them must be configured individually with the corresponding access credentials.

If two or more separate stores are registered under a single Comgate contract (e.g., www.obchod.cz and www.e-shop.com), customer support will generate unique access credentials for each store required for plugin configuration (see step 5 of the Instructions). Each store must be configured separately, and care must be taken to avoid mixing up the access credentials.

If credentials are still mixed between stores, the payment gateway integration will not be fully functional. Payments may be created, but in the wrong store, and the payment status therefore cannot be returned to Shopify. In such a case, you must contact Comgate customer support. The fix requires manual intervention by the IT department and may take some time.

Rounding of payments in the HUF currency

When creating payments in HUF on the Comgate payment gateway, the amount is automatically mathematically rounded to whole values for technical reasons. The maximum deviation is 0.5 HUF (0.032 CZK).

The Comgate payment gateway does not support processing amounts in HUF with decimal values and requires the amount to always be stated in whole HUF. For the correct creation and processing of the payment, the amount is therefore automatically adjusted.

This behaviour should not affect most merchants, as they typically already use whole-value amounts in HUF.

We recommend adding this information directly to the product, so that the payer is informed in advance about possible rounding.

Invoices in the HUF currency

When issuing invoices in HUF that contain a decimal value, it is necessary to ensure that a rounding adjustment is automatically applied so that the final amount matches the whole-value format supported by the payment gateway.

Refunds

The same rules that apply to creating payments also apply to refunds.

Google Pay, Apple Pay and PayPal

In accordance with Shopify's requirements for payment extensions, payments via Google Pay, Apple Pay and PayPal cannot be processed through the Comgate payment gateway.

Additional Fees

If the Shopify Payments service is not used and the merchant chooses a third-party payment solution (such as Comgate), Shopify charges a transaction fee. This fee can be up to 2% of the total transaction amount and depends on the plan the merchant has set up with Shopify.
Details can be found in Shopify’s official pricing list, in the feature overview under the line “Third-party transaction fees when not using Shopify Payments”.

Instructions

1) The merchant clicks on the link that leads to the details of the application in the Shopify store, where you have the option to start the installation.

2) Shopify will request to confirm the app's permission to access store data.

3) After approval, the merchant is redirected to the interface of the external application, which guides them through next steps. For Comgate, the first step is to send a registration email with technical details about the connection.

4) Then wait for a contact from Comgate that the account is ready. After that, you can get back to the application via the same link.

You can also take an alternative route in your store settings by clicking on Payments (1), in the Additional payment methods section select the Comgate payment method (2 - not pictured). On the add-on detail page, click on More actions (3) on the top right and select Manage (4).

5) The merchant fills in the data for communication with the API of the payment gateway.

6) If the data verification is successful, the final part of the process is made available to the merchant, where you can make additional gateway settings, but he must first press the "Activate" button here.

7) Then you are redirected back to Shopify with connection information, where you can turn on test mode and optionally select supported payment methods. In the lower part, there is another green "Activate" button, which will only make the gateway available for display in the store.

8) If the merchant had been using a previous payment solution, he can now deactivate it in Settings > Payments.

Payments pairing

The Comgate payment ID is not currently displayed in the order details in the Shopify admin environment. However, we sync the order names from Shopify to our system. For payment matching you can use:

• Comgate Client Portal, where both the Comgate payment ID (Comgate ID) and the Shopify order ID (ID from the client) are listed on the Customer Payments page for each payment.
  
  

• Daily or monthly billing, where both data are also listed as Comgate ID and ID from the client in a CSV file. It is possible to use both CSV and ABO formats (read specifics for ABO).

Since Shopify generates the order name after it is paid, the payment in Comgate is based with the Shopify payment ID (e.g.: rJNzsrQKFQUFHnDJeUUcZoQhL) that is generated in Shopify. This value can also be found in Shopify in the order detail timeline when you expand the payment information:

The moment the payment is made and the status is successfully transmitted to the e-shop, the Shopify order name is automatically synchronized (e.g. 1001).

How synchronisation works

The Comgate system automatically downloads order name information from Shopify (e.g. 1001), which is then available in the Client Portal in the payment summary in the ID from client column.

The synchronization always takes place a few dozens of seconds after the payment has been successfully settled and the payment status has been transmitted to the e-shop. In extreme cases, the synchronization may be delayed by several hours.

This means that in the daily and monthly exports, you will find the Shopify order name in the client ID for successfully paid payments.

The order name is also included in the order and transaction history exports directly from Shopify under the Name.

The format of a Shopify order

The synchronised format depends on the Order ID Synchronisation setting in the Clients portal.

Order Number (1005)

This is the default setting where the order number is synchronized, which does not include the prefix or suffix from the store settings (Store Details -> Order ID).

Example of order order: 1001, 1002, 1003

Order name (#1005s)

The entire order name including the prefix and suffix from the store settings (Store Details -> Order ID) is synchronized.

Example series: #1001s, #1002s, #1003s

Instructions for synchronizing orders in Shopify

To ensure the synchronization of orders and refunds between Shopify and the Comgate payment gateway, it is necessary to create a private app, obtain its credentials, and then enter them into the Comgate Client Portal. Below is the complete procedure, from creating the app to connecting it with your store in the Comgate portal and starting synchronization.

Creating an app in Shopify

1. The first step is to verify the owner of the store, i.e., the person who currently owns the store. It is required that the following configuration be performed exclusively through this person's account.
   

   Only this person is authorized to create and configure a custom application through which synchronization can be performed. If the application is created by another person, there is no guarantee that synchronization will work.

2. In the Shopify admin, go to Settings → Apps and sales channels.

3. Click Develop apps in the top-right corner.
   

4. In the displayed window, click Create an app in the Dev Dashboard.
   

5. After redirection to the Dev Dashboard, click Create App.
   

6. Enter any app name in the right panel (ideally something like “Order ID synchronization with Comgate”) and confirm by clicking Create.
   

7. In the next step, in the App URL field under URLs, enter the following address (this is only a documentation link, and after app installation you will automatically be redirected to it): https://help.comgate.cz/docs/shopify

   
   No action is required on your part. Shopify requires this field to be filled, and you can simply close the page after redirection.

8. Uncheck Embed app in Shopify admin.

9. In the Access section, click Select scopes.
   

10. Search for order and under Admin API – Orders, check read_orders.

11. Confirm by clicking Done.
    

12. Complete app creation by clicking Release at the bottom of the screen, then confirm in the popup again by clicking Release.
    

Installing the app in your Shopify store

1. In the Dev Dashboard, go to the Home tab.
   

2. Under Installs, click Install app.
   

3. Select the store where you want to install the app.
   

4. Confirm access and installation by clicking Install.
   

5. After installation, you will be redirected to the Comgate page with instructions to activate order ID synchronization (the same URL you entered when creating the app). You can close this page and continue with the instructions below.

Sharing app credentials in the Comgate Client Portal

1. In the Comgate Client Portal, go to Integrations → Store settings in the top menu.

2. Select the appropriate store.

3. In the Store connection tab, click Edit (if unsure which connection to edit, follow the instructions in How to find the correct store connection for editing).
   

4. To view additional configuration fields, the following must be filled (provided by Comgate support during payment plugin activation):

   • Paid URL

   • Canceled URL

   • Pending URL

   • Payment result URL

All URLs must contain a .myshopify.com domain.

5. If correctly filled, enable the Allow Shopify settings option.

6. Enter the app credentials from the Dev Dashboard (Client ID and Secret) in the displayed fields.
   

   

7. Select the order synchronization format.

8. Save the configuration by clicking Save.
   

How to find the correct store connection to edit

1. In the Shopify store admin, go to Settings → Payments.

2. In the list of payment methods, select the Comgate plugin.

3. Click More actions → Manage in the top-right corner.

4. Locate the field Registered store connection ID.

   • This ID identifies the specific connection that must be edited in the Comgate Client Portal. Do not change any other connections.

Using one app for multiple stores

If you need to synchronize orders from multiple Shopify stores, you do not need to create a new app for each store. Simply install the same app from the Dev Dashboard into the other stores and configure each one separately in the Comgate Client Portal.