使い方ガイド
このページで扱うトピック
このページでは、Opn Paymentsのサービスをご利用いただくための流れをステップ毎にご説明します。技術的な専門知識をお持ちでない方でも、一連の流れをご理解いただける構成となっています。
1. サインアップ
Omiseアカウントは簡単に作成可能です。まず、Opn Paymentsウェブサイトの各ページ右上に設置されたアカウント登録ボタンをクリックしてください。
メールアドレスを記入し、アカウントのパスワードを設定します。パスワードは10文字以上で以下の条件を満たす必要があります。
- 最低1個以上の小文字、大文字、数字
- 最低1個以上の記号 例:@ & # ?
サインアップ情報を送信すると、「ダッシュボード」画面が表示され、メールアドレスの認証を行なうよう要求されます。 画面の指示に従って操作してください。
上部のメニューバーからテストダッシュボードもしくはライブダッシュボードをクリックすることで、運用環境をお選びいただけます。
- テストダッシュボードはsandbox(ソフトウェアテスト環境)ですので、実際の決済が処理されることはありません。
- ライブダッシュボードではカード保有者とカード発行会社間で、実際の取引が発生します。
ライブダッシュボード、テストダッシュボードのいずれかの処理がもう片方のダッシュボードに影響を与えることはありません。
2. 課金を行う
ダッシュボード上の課金ページを開いて、課金を作成してみましょう。コマンドライン上でAPIを呼び出し、課金を作成処理をテストします。
Macの場合: 「ターミナル」を起動します。「ターミナル」は「ユーティリティ」フォルダの中にあります。
Finder>アプリケーション>ユーティリティ>ターミナル
Windowsの場合: curlを実行するため、Git-Bashの使用をお勧めします。 (Git-SCMをダウンロード)
次に、ダッシュボード上の「課金」ページにあるトークンを使用して課金をクリックします。
ここで、2組のコードが表示されます。 最初のコードはトークンの作成のため、2番目のコードはカードへの課金を行うために使用します。
最初のコードセットをターミナルにコピー&ペーストし、実行します。 (サンプルコードにはすでにテスト用カードとキーの情報が設定されています)
レスポンスがJSON形式で返り、作成されたトークン情報が 「id」 の値として表示されます。2番目のコード上にある token_id
の値を受信したトークンIDに置き換え、ターミナルにコピー&ペーストし、実行します。
ダッシュボード上の「課金」ページ上に新たに作成された課金の情報が表示されます。
3. 売上の振込を行う
処理された課金は一定の保留期間(日本:21日間、タイ:7日間)の後、振込可能残高として取り扱われ、その金額の範囲であれば、 自由に残高を引き出すことが可能です。
注:テストダッシュボードの場合、課金処理されたか金額は保留期間なしにすぐさま振込可能として扱われます。
残高を銀行口座に振込まれたい場合は、振込を行う
を クリックしてください。
振込を行う際に、全額振込(「振込可能残高」として表示されている全額をお振込)もしくは一部振込(「振込可能残高」の範囲内で金額を指定してお振込)をお選びいただけます。
振込を行う際に、振込情報が作成されますが、そのステータスは「保留」として表示されます。Opn Paymentsでは1日1回まとめて振込要求を銀行へ送信するため、直ちにお振込が処理されることはありません。
銀行が指定された口座への振り込みを正常に処理すると、Opn Payments側に振込完了の通知があり、そのメッセージをお客様へ表示致します。
注:テストダッシュボードの場合、ステータスをご自身で変更することが可能です。銀行への振込要求が送信された状態をシミュレートするためには振込リクエスト済みにするをチェックし、銀行からの応答を得た状態をシミュレートするためには、振込済みにするをチェックして、ステータスを変更してください。
振込が作成され、銀行に振込要求が送信された時点で(ステータスが「送信済み」となった時点で)、振込可能残高から指定されたお振込額が差し引かれます。
振込指定された売上金は翌日、お客様の銀行口座に振り込まれます。
注:振込指定された金額が「振込可能残高」を上回る場合、振込処理は実行されません。ステータスは「保留」のまま、翌日に再度振込が試行されます。
4. プラグインのダウンロードとインストール
上記以外の Eコマースプラットフォームをご利用の場合、もしくはお客様ご自身でウェブサイトを作成している場合にご活用いただけるSDKのリストは以下の通りです。
- Ruby: github.com/omise/omise-ruby
- NodeJS: github.com/omise/omise-node
- PHP (Composer): github.com/omise/omise-php
- Java Script: github.com/omise/omise.js
- Go: github.com/omise/omise-go
- Java: github.com/omise/omise-java
- Python: github.com/omise/omise-python
モバイルアプリに実装する場合は以下のリンクをご参照ください。
- Android: github.com/omise/omise-android
- iOS: github.com/omise/omise-ios
プラグインやComposerを使わずにPHPサイトでOpn Payments APIをご利用になる場合は、下記の手順をご参考ください。
まずindex.htmlに次の行を追加します。
<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="jpy"
>
</script>
<!--the script will render <input type="hidden" name="omiseToken"> for you automatically-->
</form>
<!-- data-key="YOUR_PUBLIC_KEY" -->
</body>
</html>
YOUR_PUBLIC_KEY
をご自身のパブリックキー(ダッシュボードからキー情報を確認できます)に書き換え、PATH_TO_LOGO_IMAGE
をお好みの画像URLに置き換えます。例:http://bit.ly/customer_image
支払者がカード情報の入力に使用するindex.htmlを作成し、課金を実行するためのcheckout.phpを作成してください。omise-phpライブラリはgithub.com/omise/omise-phpから入手することができます。ファイルを解凍し、フォルダ名をomise-php-masterからomise-phpに変更します。
ライブモードで作業するときは、コードを最新の状態を簡単に保つため、git cloneを使用されることをお勧めしています。
<?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' => 'jpy',
'card' => $_POST["omiseToken"]
));
echo($charge['status']);
print('<pre>');
print_r($charge);
print('</pre>');
コード上にあるサンプルプライベートキーとシークレットキーのセットをご自身のキーに置き換えてください。
Omise.jsを利用すると今すぐ支払うボタンを作成することができます。このボタンをクリックしますと、決済フォームが表示されるため、テスト用カードの情報を使って決済機能を試すことが可能です。
名前: JOHN DOE
番号: 4242424242424242
有効期限月: 12
有効期限年: 2020
セキュリティコード: 123
フォームが送信され、課金が成功しますと、通知メッセージが表示されます。
開発に関する詳細はドキュメントからご確認頂けます。ご覧頂いた後にもご質問がある場合は、 サポートにご相談ください。
5. ライブモードを有効にする
実際のクレジットカードを使って商用での決済を開始するには、 ライブダッシュボードを有効にする必要があります。ライブアカウントの申請をする場合、 オンラインにて必要な情報を記入、書類をアップロードください。
ライブダッシュボードを選択し、申請情報の記入・変更をクリックします。 下記の文書は提出する必要があるものですので、お手元にあることをご確認下さい。
<タイ国内で加盟店登録される場合>
会社の場合:
- VAT証明書 (Tax ID/ภ.พ. 20)
- 会社の登録書類 (หนังสือรับรองบริษัท DBD)
- 取締役のIDカード
- ご希望のタイ銀行の通帳(入金用)の口座番号が掲載されたフロントページ
個人の場合:
- ご自身のIDカード
- ご希望のタイ銀行の通帳(入金用)の口座番号が掲載されたフロントページ。この口座名義はIDカードと一致している必要があります。
<日本国内で加盟店登録される場合>
- 銀行の通帳表紙または、銀行カードのコピー(写真可)
- 通帳やキャッシュカードがない場合は、口座名や口座番号がわかるオンラインアカウントのスクリーンショット
- 金融商品、旅行商品・酒類・米穀等、その販売に政府機関の許可、認可、免許、承認もしくは同意又は政府機関への届出、通知もしくは登録を要する商品等を取り扱う場合には、予め許認可等を証する書類
- 個人/個人事業主でお申込みの方は本人確認ができる書類
- 記入済み JCB/アメリカン・エキスプレス/ダイナースクラブ 審査表
注:ファイルはPDF、JPG、PNGまたはXLS/XLSX形式のものをアップロードしてください。
関連記事:
売上金はいつ入金されますか?