Welcome to the Omise Docs

These pages contain everything you need to know to accept payments using the Omise API.

This is developer-oriented documentation. If you are not a developer, check our comprehensive support articles for non-technical explanations of various concepts, or go straight to the plugin overview.

The docs are organized into four sections:

• Guides: An introduction to how our system works, including a security overview and a guide to collecting card information safely.
• Plugins: Already have an online store? You may be able to easily integrate our API using one of our plugins.
• Payment Methods: In addition to credit cards, we support an ever-growing list of payment methods. Learn how to implement them through comprehensive walkthroughs with code and API response examples.
• API References: Our complete API documentation, including guidance on authenticating with our API, standard error codes, and detailed information on all available endpoints.

What is Omise?

Omise is a PCI-certified payment gateway with an easy-to-use management dashboard and an intuitive REST API that allows integration across a variety of languages and frameworks.

We give you the power to 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 sample code in both test and live mode. It also provides your account keys, which are required to perform any action using our API, such as creating or refunding a charge.

You can find your public and secret keys under API > Keys in the dashboard menu.

Running the examples

To run any of the sample code on this site, replace the sample key shown (skey..., $OMISE_SECRET_KEY, pkey..., or $OMISE_PUBLIC_KEY) with the one specific to your account, found in your dashboard.

Choosing an integration

Omise integrates with various e-commerce solutions via plugins. For more custom solutions, we provide libraries for JavaScript, iOS, Android, and many other languages.

Before using any plugin or library, please read the documentation specific to that integration.

Whatever solution you choose, never send sensitive information (for example, credit card details) directly through your server. Check our Security Best Practices to learn more.

Going live

To enable your live account, see this document.

Have questions?

If you're having trouble using our service or want to learn more, contact us directly. You can check the current status of the API at status.omise.co or follow @omisestatus on Twitter.