How can we help?

How can I update my API version?

Last updated on June 19, 2026

Short answer: You can update your API version from the API Versions page in the Omise Dashboard.

API versions represent changes that are not backward compatible with previous releases (also known as breaking changes). For example, a new API version may introduce a mandatory field such as Phone field for the Customer object.

When a new API version becomes available, we recommend following the process below.

1. Check for available updates
Visit the API Versions page in your dashboard to see whether a newer API version is available.

2. Update Test Mode
Before updating your production environment, switch to Test Mode and update your API version to the latest available version. To access Test Mode, click Switch to test mode in the upper-left corner of the dashboard.

3. Verify your integration
Test your application against the new API version and ensure that all functionality works as expected. Because API version updates may contain breaking changes, you should confirm that your integration is fully compatible before proceeding.

4. Update Live Mode
Once testing is complete and your application has been deployed, switch to Live Mode and update your API version. To access Live Mode, click Switch to live mode in the upper-left corner of the dashboard.

Can’t find your answer?

Get in touch with us and we’ll get back to you as soon as possible

Omise uses cookies to improve your overall site experience and collect information on your visits and browsing behavior. By continuing to browse our website, you agree to our Privacy Policy. Learn more