Getting started

Omise Docs has everything you need to start accepting payments with the Omise API.

Not sure where to start? Here's the fastest way to find what you need:

• 🔌 Integrations — Already have an online store? Integrate quickly using one of the available integrations.
• 📖 Guides — Building something custom? Start here for an introduction to how the Omise system works, including a security overview and a guide to collecting card information safely.
• 💳 Payment Methods — Curious what's supported? In addition to credit cards, Omise supports an ever-growing list of payment methods, with full implementation walkthroughs including code and API response examples.
• 🗂️ API References — Need the technical details? Read the complete API documentation, covering authentication, error codes, and every available endpoint.

ℹ️ About Omise

Omise is a PCI-certified payment gateway with an easy-to-use management dashboard and an intuitive REST API that integrates with many languages and frameworks.

Omise lets you implement payments the way you want, without the risk and overhead of handling payment details directly.

🔑 Setting up your account

To get started, register for a test account so you can work on your implementation before going live.

The dashboard provides transaction information, account-level settings, and example code in both test and live mode.

It also provides your account keys, which are needed to perform any action using the API, such as creating or refunding a charge. You can find your public and secret account keys under Keys in the API section of the menu.

▶️ Running the examples

To run any of the code samples on this site, you should replace the sample key shown (skey..., $OMISE_SECRET_KEY, pkey..., or $OMISE_PUBLIC_KEY) with the corresponding key from your account, which you can find in your dashboard.

🧩 Choosing an integration

Omise connects with various e-commerce solutions through integrations.

For more custom solutions, Omise provides libraries and SDKs for JavaScript, iOS, Android, and many other languages and platforms.

Before using any integrations or libraries, please read the documentation for that integration.

🚀 Going live

Once your test implementation is ready, you can apply for a live account entirely online through your Omise dashboard by switching to live mode and completing the application form (Merchant Details, Business Details, Bank Details, and Other Details).

You'll also need to submit verification documents. The required documents depend on your country (Thailand, Singapore, Japan, or Malaysia) and whether you're registering as a business or an individual. Once you submit your application, Omise's KYC team reviews it and will be in touch within about 30 business days, or sooner if they need additional information.

Once your account is approved, your dashboard will provide a set of live keys (pkey_... / skey_...) alongside your existing test keys (pkey_test_... / skey_test_...). Update your integration to use the live keys in place of the test keys shown in the code samples above.

See the full guide on how to enable a live account for the complete list of requirements and documents for your country.

💬 Getting help

If you are having issues using Omise's service or want to learn more, you can contact Omise directly. You can check the current API availability at status.omise.co or follow @omisestatus on X.