Skip to main content

Activate Checkout API

To use the Mobile Checkout SDK, you must activate Checkout API in the Comgate client portal. Activation is very simple - just sign in to the client portal and follow the steps below.

Tip

The Wallets & SDK section also contains settings that apply only to the Web Checkout SDK (Checkout SDK (web), Apple Pay, Google Pay, allowed website addresses). These items are not relevant for the Mobile Checkout SDK. Ignore them and focus only on Checkout API activation according to this documentation.

Activation​

  1. In the menu, select Services → Checkouts and open the checkout (shop) for which you want to activate Checkout API.

  2. On the Shop connection tab, click the connection through which you want to process payments. Its detail opens; click Edit.

  3. In the Wallets & SDK section, tick the Mobile SDK item.

https://app.comgate.eu/

alt text

  1. The Allowed applications list appears. Use the Add application button to add the package names of all your mobile applications — each application as a separate entry.
https://app.comgate.eu/

alt text

  1. Click the Save button.

Activation is now complete.

Getting checkoutId​

To use Checkout API, you need the checkoutId value, which uniquely identifies the store connection:

  1. Go to the shop connection list, see step 1 above in Activation.
  2. In the list, click the required connection — its detail opens.
  3. In the Wallets & SDK section, find the Checkout ID field. Copy the value using the icon next to the field.
https://app.comgate.eu/

alt text

Tip

Pass the obtained checkoutId value to the ComgateSecureSession constructor when initializing the library.

Android app registration​

During initialization, the library verifies whether the calling application is authorized to use the given store connection. For successful initialization, you must add your app package name to the allow-list of applications. This setting is located in the same place in the client portal as the checkoutId value described above.

Information

You can find the correct package name in your app configuration in build.gradle(.kts) as applicationId, or in AndroidManifest.xml as the package attribute.

If the app is not on the allow-list, the library rejects initialization and returns an error.