Library Updates Required

If you are using a library provided by Omise, API requests (including charge creation) may soon stop working for you. In the past, our libraries used a security feature known as certificate pinning. However, this is no longer considered best practice. Please ensure you are using the latest version of your library or plugin. New releases regularly include new features, bug fixes, and performance enhancements. If it is not possible to use the latest version, please upgrade to the minimum required version as specified in the next section.

Minimum required versions

The following table lists the minimum required versions of each library along with its release date and full changelog.

Libraries not listed in this table should be considered unaffected. However, please check this page periodically for any updates.

Updating libraries

The following sections document how to update each library and the points to be aware of when updating. Note that each section provides only a basic example. Your environment may vary, and you may update using any method you choose.

SDK: Android

Change the version in the build.gradle file of your app inside the dependencies section:

dependencies {
  implementation 'co.omise:omise-android:3.0.0'
}

Note the following point when updating from an older version to a later version:

Upgrading from version 2.6.5 to 2.6.6 drops support for TLS 1.1. Use TLS 1.2 or higher. For more information, see the TLS depreciation page.

SDK: iOS

See the upgrade steps using Swift Package Manager. 4.x branch drops support for iOS 10 and Swift 4.

Library: Go

Update to the latest version:

go get github.com/omise/omise-go 

Update to a specific version:

go get github.com/omise/omise-go@v1.0.5 

Library: Java

Change the version in the build.gradle file of your app inside dependencies section:

dependencies {
  implementation 'co.omise:omise-java:3.1.1
}

Note the following points when updating from an older version to a later version:

• There are no breaking changes when upgrading from version 4.x to the latest version, and the upgrade should be smooth.

• There are breaking changes when upgrading from version 3.1.1 to version 4.0. See the migration guide for more information. If you cannot upgrade to the latest version, upgrade at least to the latest recommended version - version 3.1.1.

• When upgrading from version 2.x to version 3.0.0, there are breaking changes. See the migration guide for more information.

Library: PHP

Update the version specified in composer.json to at least the minimum required version. Then, run the update command:

composer update omise-php

Upgrading from any version 2.x should be straightforward as there are no breaking changes, but we recommend using non-EOL PHP versions.

Library: Python

Update the version specified in requirements.txt to at least the minimum required version. Then, run the update command:

pip install --upgrade omise

Upgrading from any version should be straightforward as there are no breaking changes, but we recommend using non-EOL Python versions.

Library: Ruby

Update the version specified in Gemfile to at least the minimum required version. Then, run the update command:

bundle update omise

Upgrading from any version should be straightforward as there are no breaking changes, but we recommend using non-EOL versions of Ruby.

Updating PHP-based plugins

EC-CUBE

Please refer to the official documentation for installation and configuration details.

Magento

Please refer to the official documentation for installation and configuration details.

OpenCart

Please refer to the official documentation for installation and configuration details.

PrestaShop

Please refer to the official documentation for installation and configuration details.

WooCommerce

Please refer to the official documentation for installation and configuration details.

Update the server certificate

If you cannot access Omise APIs after updating the libraries, you need to update the G2 certificate on the server. For more information, see this KB article from Digicert.

To update the certificate, use one of the following procedures depending on your OS.

On Linux

Linux stores the CA (certificate authority) TLS/SSL certificates in the /etc/ssl/certs/ directory. The system installs the latest CA when you update the OS. To manually update the CA, use one of the following procedures depending on the distribution.

RHEL and clones

1. Create the /etc/pki/ca-trust/source/anchors directory if it does not already exist.

2. Download the DigiCert Global Root G2 file .

3. Copy the PEM files downloaded in the previous step into the /etc/pki/ca-trust/source/anchors directory.

4. Integrate the certificates into the system's certificate set. Run:

   sudo update-ca-trust 
   

Debian and derivatives

1. Create the /usr/local/share/ca-certificates directory if it does not exist.

2. Download the DigiCert Global Root G2 file.

3. Copy the PEM files downloaded in the previous step into the /usr/local/share/ca-certificates directory and change the suffix of each file to .crt.

4. Integrate the certificates into the system's certificate set. Run:

   sudo update-ca-certificates 
   

On Windows

The system installs the latest CA when you update the OS. To manually update the CA:

1. Open a cmd prompt as admin.

2. Navigate to a folder somewhere, for example C:\Temp.

3. Type:

   CertUtil --generateSSTFromWU Rootstore.sst
   

The system downloads the current root certificate updates and writes them to the file Rootstore.sst.

Copy the Rootstore.sst file from the path in Step 2 to the machine(s) that (do)es not have Internet access.

Have questions?

If you are having issues using our service or want to learn more, you can contact us directly. You can check the current availability of API at status.omise.co.