Step by Step Guide

This guide is to help you find your way around Omise with an easy step-by-step approach. It’s detailed, comprehensive and easy to follow; ideal for a non tech-savvy.

  1. Signing up
  2. Charging cards
  3. Transferring funds
  4. Plugin download & installation
  5. Enabling live mode

1. Signing up

Signing up for an Omise account is simple. You'll find Register on the top-right corner of every page on our site.

register button on top left

Fill in your email address and set a password for your account.
Remember that the password must contain at least 10 characters and must include:

  • one uppercase character, one lowercase character and a number
  • one special character ex. @ & # ?

Once you submit, you’ll be directed to your dashboard and asked to verify your email address. Follow the onscreen instructions.

dashboard page

The working environments, Test dashboard and Live dashboard can be selected from the menu bar at the top.
- Test Dashboard is the sandbox mode, no live transactions take place
- Live Dashboard is where all transactions occur in actual, with cardholders and banks

Note that both environments are mutually exclusive.

2. Charging cards

To create your first charge, click on Charges. We’ll start testing by making an API call from the command line.

For mac: Open Terminal
Go to Finder> Application>Utilities>Terminal

open terminal application

For Windows: We recommend Git-Bash to run curl. (Download Git-SCM)

git bash

Once all set, click on Create a charge with a token.

charge page

2 sets of codes will appear. The first is used in creating a Token, and the second charges the card.

open charge command line

Copy the first set of code to Terminal. (The sample code shown already includes card details and key.)

call request token api

The system will return a JSON response. The Token generated is displayed next to “id”. Copy the second set of code to Terminal and replace token_id with the Token id received.

call_charge_api

Check your dashboard. The successful transaction will appear under Charges.

got charge from charge page

3. Transferring funds

Payments received will be under On hold for 7 days before the funds are moved to the Transferable balance. Only funds in the transferable balance can be withdrawn from an Omise account.
Note: In test dashboard the received amount will automatically go to your Transferable balance.

Whenever you wish to make a transfer, click on Setup a transfer.

transfer page

With Omise you have 2 options of transfers; a full transfer (the total amount will be transferred from the Transferable balance) and partial transfer (a specific amount is transferred).

request full transfer

When you Setup a Transfer, a transfer will be created but its status will be set to Pending. Unlike banks, we can’t process transfers right away. We batch them and send them once a day around 10 am.

overview of transfer process

Once the bank successfully processes the transfer to your account, Omise gets notified with a Transfer Success notification. We will then pass that message on to you.

Test mode: You could easily simulate the process by checking Mark as sent to indicate that the transfer request has been sent to the bank and check Mark as paid to indicate the bank’s response.

mark as sent button

Once a transfer is created and request sent to the bank, the amount will be deducted from your Transferable balance.

send request to bank show in transfer page

The funds will be transferred to your bank account the next day.

Note: If the amount requested is greater than the amount available in your transferable balance, the transfer will be unsuccessful, the status will be changed to pending and the transfer will be retried on the next day.

4. Plugin download & installation

For e-commerce sites that aren’t listed or if you’ve built your own site, here’s the list of available SDKs:

implementing to a mobile app?

or with console on your website:

If your using our API with a PHP site without a plugin or composer here’s what to do.

Download card.js from github.com/omise/card.js. Unzip it and create an index.html file in the same folder.

<html>
<head>
</head>
<body>
<form name="checkoutForm" method="POST" action="checkout.php">
  <script type="text/javascript" src="https://cdn.omise.co/omise.js"
    data-key="pkey_test_52jyu0r8o4307z0zz00"
    data-image="http://bit.ly/customer_image"
    data-frame-label="Merchant site name"
    data-button-label="Pay now"
    data-submit-label="Submit"
    data-location="no"
    data-amount="10025"
    data-currency="thb"
    >
  </script>
  <!--the script will render <input type="hidden" name="omiseToken"> for you automatically-->
</form>

<!-- data-key="YOUR_PUBLIC_KEY" -->
</body>
</html>

Change YOUR_PUBLIC_KEY to your own key (can be found on your dashboard) and change the PATH_TO_LOGO_IMAGE to a URL of an image. For example http://bit.ly/customer_image

Once you’ve created the index.html which is used for collecting card information, create checkout.php to charge cards. You’re able to get the omise-php library from github.com/omise/omise-php. Unzip the file and rename the folder from omise-php-master to omise-php

When working in live mode, we do recommend using git clone as it is easier to keep codes up-to-date.

<?php

require_once dirname(__FILE__).'/omise-php/lib/Omise.php';
define('OMISE_API_VERSION', '2015-11-17');
// define('OMISE_PUBLIC_KEY', 'PUBLIC_KEY');
// define('OMISE_SECRET_KEY', 'SECRET_KEY');
define('OMISE_PUBLIC_KEY', 'pkey_test_52jyu0r8o4307z0zz00');
define('OMISE_SECRET_KEY', 'skey_test_52jyu0r8mim84ylp454');

$charge = OmiseCharge::create(array(
  'amount' => 10025,
  'currency' => 'thb',
  'card' => $_POST["omiseToken"]
));

if ($charge['status'] == 'successful') {
  echo 'Success';
} else {
  echo 'Fail';
}

print('<pre>');
print_r($charge);
print('</pre>');

The code already contains a set of private and secret keys. Replace them with your own keys, and you’re ready to test the code.

example in browser

Card.js creates a Pay now button. Click on it and a payment form will appear. You can use the details below for testing:

Name: JOHN DOE
Number: 4242424242424242
Expired month: 12
Expired year: 2020
Security code: 123

Once the form is submitted and the charge is successful, a notification message will appear.

Learn more from our documentation or if you still have questions after reading, head over to support.

5. Enabling live mode

To start receiving actual transactions, you’ll have to enable live dashboard. A few documents must be submitted online for approval.

live dashboard

Select Live dashboard and Fill your application. Note that the documents listed below will have to be submitted, so have them handy!

For businesses:

  • VAT certification (Tax ID/ภ.พ. 20)
  • Company's registration document (หนังสือรับรองบริษัท DBD)
  • Director's ID card
  • Front page of your preferred Thai Bank passbook showing the account number that will collect funds.

For individuals:

  • Your ID card
  • Front page of your preferred Thai Bank passbook showing the account number that will collect funds. This account must match the ID card.

Note: Files must be in PDF, JPG or PNG

Relates articles:
How long does Omise hold my money?