Omise API Reference

Complete API documentation for the Omise payment platform.

The Omise API is organized around REST. Our API accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL

https://api.omise.co

API Version

2019-05-29

API Resources

Charges

Create and manage payment transactions via cards, PromptPay, mobile banking, and more.

Refunds

Refund all or part of a previously captured charge back to the customer.

Customers

Store customer information and payment methods for recurring charges.

Sources

Create payment sources for PromptPay, TrueMoney, mobile banking, and other methods.

Authentication

The Omise API uses different keys depending on the context:

Public Key

pkey_test_...

Used client-side for tokenizing cards via Omise.js

Secret Key

skey_test_...

Used server-side for charges, refunds, and other operations

Example: HTTP Basic Auth with secret key

curl https://api.omise.co/charges \
  -u skey_test_your_secret_key:

Full API schema available at api.omise.co/schema