VibeFox Omise for WooCommerce — ヘルプ
要件
WordPress:6.2 以降。
WooCommerce:8.0 以降。インストールされ、有効になっている必要があります。WooCommerce がなければプラグインは有効化できません。後から WooCommerce を無効にすると、ゲートウェイは読み込まれず、管理者向けの通知が表示されます。
PHP:8.0 以降。
HTTPS:カード入力欄はチェックアウトページにあるため、チェックアウトは HTTPS で提供され、信頼できないスクリプトが含まれていない必要があります。ただし、カード情報がサーバーに届くことはありません。Omise は HTTPS のアドレスにのみ Webhook を送信します。
ストアの通貨:THB、JPY、SGD、MYR、USD、EUR、GBP、AUD、CAD、CHF、CNY、DKK、HKD のいずれか。それ以外の通貨の場合、チェックアウトでこの決済方法は表示されません。
Omise アカウント:テストモードと本番モードの両方で、Omise アカウントの公開キーと秘密キーが必要です。これらは Omise ダッシュボードの Settings > Keys にあります。また、Settings > Webhooks に Webhook エンドポイントを設定する必要があります(設定方法は「構成」を参照)。
VibeFox ライセンスキー:vibefox.net で購入します。1 つのキーは 1 つのドメインで使用できます。
インストール
1. WordPress で Plugins > Add New > Upload Plugin に進み、プラグインの ZIP ファイルを選択して Install Now をクリックします。FTP で wcp_omise_payment フォルダを /wp-content/plugins/ にアップロードすることもできます。
2. Activate をクリックします。
3. 設定を開きます:WooCommerce > Settings > Payments > Omise > Manage。または、プラグインページでプラグイン名の下にある Settings をクリックします。
4. ページ上部のライセンスブロックに VibeFox ライセンスキーを入力し、Activate をクリックします。
5. Omise のテストキーと本番キーを入力し、設定ページに表示されている Webhook URL を Omise ダッシュボードに追加します(「構成」を参照)。
6. Enable/Disable を有効にします。テストモードで Omise のテストカード(例:4242 4242 4242 4242)を使用して決済をテストしてから、Test mode のチェックを外します。
構成
すべての設定は 1 つのページにあります:WooCommerce > Settings > Payments > Omise。テストモードが有効な間、ページのフィールドの上に Test mode is on — orders are charged with the test keys, no real money is moved. と表示されます。現在のモードの公開キーまたは秘密キーが不足している場合や、ストアの通貨が Omise でサポートされていない場合も警告が表示されます。どちらの場合も、チェックアウトでこの決済方法は表示されません。決済方法の一覧では、現在のモードの両方のキーが入力されるまで、Omise は設定が必要として表示されます。
一般
Enable/Disable: Enable card payments via Omise で、この決済方法のオン/オフを切り替えます。初期値:オフ。
Title: チェックアウトで購入者に表示される決済方法の名称。初期値:Credit / Debit Card。
Description: チェックアウトでカードフォームの上に表示されるテキスト。初期値:Pay securely with your credit or debit card via Omise。
API キー
キーは Omise ダッシュボードの Settings > Keys で確認できます。テストキーは pkey_test_ と skey_test_ で始まり、本番キーは pkey_ と skey_ で始まります。保存時に、接頭辞が誤ったキー(例:本番用の欄にテストキーを入力した場合)は、エラーとともに拒否され、以前の値が保持されます。
Test mode: Use the test keys (no real charges)。両方のキーを切り替えます。注文の返金、キャプチャ、ステータス確認は、注文が支払われたモードのキーを常に使用します。初期値:オン。
Test public key: テストモードの公開キー、pkey_test_...
Test secret key: テストモードの秘密キー、skey_test_...
Live public key: 本番モードの公開キー、pkey_...
Live secret key: 本番モードの秘密キー、skey_...
支払いと Webhook
このセクションには、ストアの Webhook URL が表示されます。形式は次のようなものです:https://your-site/wp-json/omise-payment/v1/webhook。設定に表示されているとおりに正確にコピーし、Omise ダッシュボードの Settings > Webhooks に追加してください(HTTPS のみ)。プラグインは次のイベントを処理します。
Webhook の内容は決して信頼されません。課金は注文に保存されているものと一致する必要があり、そのステータスは注文のモードのキーを使って Omise API から再取得されます。Webhook がない場合、3-D Secure 中に購入者がブラウザを閉じた注文は、Omise: Sync payment status を実行するまで保留のままになります。また、Omise ダッシュボードで行われたキャプチャは自動的に取り込まれません。
Payment action: カードの金額をどのように扱うか。
Per-charge webhook: Send the webhook URL with every charge。複数のストアが 1 つの Omise アカウントを共有している場合に便利です。サイトが HTTPS を使用している場合のみ機能します。それ以外の場合は、ダッシュボードの Webhook が使用されます。初期値:オフ。
詳細設定
Debug log: Log API requests and payment events を有効にすると、決済のステップが WooCommerce > Status > Logs に、ソース wcp_omise_payment で記録されます。キー、トークン、カード情報は決してログに記録されません。初期値:オフ。
Delete data on uninstall: Remove the settings and debug logs when the plugin is deleted。初期値:オフ。
チェックアウト
購入者は決済方法(初期値は Credit / Debit Card)を選択し、カードフォームに Name on card、Card number、Expiry month (MM)、Expiry year (YYYY)、Security code (CVV) を入力します。テストモードでは、フォームに TEST MODE — use Omise test cards (e.g. 4242 4242 4242 4242), no real charges are made. と表示されます。注文が確定すると、Omise.js がブラウザー内でカードを 1 回限りのトークンに変換します。カードの入力欄がストアのサーバーに送信されることはありません。
ストアは、注文の合計金額について、注文の通貨で秘密キーを使って課金を作成します。課金の説明はストア名と注文番号になり、注文 ID は課金のメタデータに保存されます。銀行が 3-D Secure を要求した場合、購入者は銀行にリダイレクトされ、その後ストアに戻ります。結果は常に Omise API から再取得されます。
注文は、Omise が確認した後にのみ支払い済みとしてマークされます。課金がキャプチャされており、金額と通貨が注文と正確に一致している必要があります。Authorize only の場合、承認が成功すると注文は保留になります。購入者には注文受付ページが表示されます。
カードが拒否された場合、または 3-D Secure が失敗した場合、購入者はチェックアウトに残り、Payment failed: と理由(残高不足、セキュリティコードの誤り、カード発行会社による拒否など)が表示され、再試行できます。3-D Secure の失敗後は、購入者は Pay for order ページに移動します。3-D Secure の直後に支払いを確認できない場合、購入者には We could not confirm your payment yet. If your card was charged, the order will be updated automatically — please do not pay again. と表示されます。
再試行で二重に請求されることはありません。注文の前回の課金がすでに支払い済みまたは承認済みであれば、新たな課金は行われずに注文が完了します。未完了の 3-D Secure の試行は、新しい課金が作成される前に期限切れになります。
この決済方法は、クラシックチェックアウト、チェックアウトブロック、Pay for order ページで動作します。WooCommerce High-Performance Order Storage(HPOS)と互換性があります。
プラグインはカード決済のみに対応しています。その他の Omise の決済方法(PromptPay、TrueMoney、モバイルバンキング、分割払い、Konbini、PayNow)、保存済みカードや Omise の顧客、サブスクリプション、部分キャプチャには対応していません。
注文と返金
注文ステータス
支払い待ち:購入者が 3-D Secure の画面にいるか、まだ支払いを完了していません。
処理中:支払いが確認されました。仮想のダウンロード可能な商品のみの注文は、WooCommerce の通常の動作どおり、完了になります。注文メモには、金額、課金 ID、確認方法(チェックアウト、3-D Secure からの戻り、Webhook、手動キャプチャ、または手動同期)が表示されます。トランザクション ID は Omise の課金 ID(chrg_...)です。
保留、キャプチャ待ち:Authorize only によってカードが承認されました。Omise: Capture payment または Omise: Void authorization を使用してください。
保留、確認待ち:Omise がまだ支払いを確認していません。例えば、購入者が 3-D Secure の途中でブラウザを閉じた場合です。Webhook または Omise: Sync payment status で注文が更新されます。
保留、金額の不一致:課金の金額または通貨が注文と異なります。メモに両方の値が表示されます。注文を確認し、完了させるか、支払いを返金してください。
失敗:支払いが拒否されました。支払い済みの注文は、後から届いた失敗イベントによって格下げされることはありません。
キャンセル済み:課金の有効期限が切れたか、承認が取り消されました。
すでにキャンセル済みまたは返金済みの注文に対して、支払い済みまたは承認済みの課金が届いた場合、注文は再度開かれません。メモで、Omise ダッシュボードを確認し、手動で返金するか注文を再度開くよう求められます。
注文操作
Omise: Capture payment: 承認された全額をキャプチャします。承認された注文にのみ表示されます。
Omise: Void authorization: 承認を取り消します。お金はキャプチャされず、注文はキャンセルされます。承認された注文にのみ表示されます。
Omise: Sync payment status: Omise から課金を読み込み、注文を更新します。メモには、Omise で返金された合計額も表示されます。
返金
注文を開き、Refund をクリックして金額を入力し、Refund via Omise をクリックします。全額返金と部分返金に対応しています。返金は支払いが行われたモードで送信されるため、そのモードの秘密キーが設定されている必要があります。返金が成功すると、Omise の返金 ID とともに注文メモに追加されます。まだキャプチャされていない承認に対しては、全額返金のみが可能で、その場合は承認が取り消されます。Omise が返金を拒否した場合、WooCommerce には Omise のメッセージとともに Refund failed. が表示され、返金は記録されません。
Omise ダッシュボードで行われた返金は、WooCommerce の返金としては取り込まれません。Omise: Sync payment status で返金済みの合計額を確認できます。必要に応じて、WooCommerce で対応する手動の返金を作成してください。
ライセンスキー
このプラグインは、vibefox.net で取得した VibeFox ライセンスキーで動作します。ライセンスブロックは WooCommerce > Settings > Payments > Omise の上部にあります。キーを License key に貼り付け、Activate をクリックします。ブロックには、ライセンスの有効期限日やドメインなどのステータスが表示されます。Check now でステータスを再確認し、Change key で別のキーを入力し、Remove key でこのサイトからキーを削除できます。Manage licenses and domains in your account のリンクから vibefox.net のアカウントを開けます。
1 つのキーは 1 つのドメインで使用できます。サイトからキーを削除しても、ドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。
有効なキーがない場合、チェックアウトで購入者に Omise は表示されません。それでも決済が開始された場合、購入者には This payment method is not available. Please choose another one. と表示されます。ログイン中のストア管理者には、(unlicensed — visible to admins only) と表示された状態で決済方法が引き続き表示されるため、キーを購入する前にプラグインを設定してテストできます。プラグインページと WooCommerce のページにリマインダーが表示されます。既存の注文には影響しません。開始済みの支払いは引き続き確認され、キャプチャと返金も機能します。
ライセンスの期限が切れても、プラグインは動作を続けますが、アップデートとサポートには更新が必要です。ステータスはバックグラウンドで自動的に再確認されます。
トラブルシューティング
チェックアウトに Omise が表示されない:ライセンスが有効であること、Enable/Disable がオンであること、現在のモードのキーが両方とも入力されていること(テストモードではテストキー、それ以外は本番キー)、そして通貨がサポートされていることを確認してください。Pay for order ページでは注文の通貨が対象になります。キーまたは通貨が正しくない場合、設定ページに警告が表示されます。
支払いは完了したが、注文が支払い待ちまたは保留のまま:Webhook が機能していません。Omise ダッシュボードで、Webhook URL が設定に表示されているものと完全に一致し、HTTPS を使用していることを確認してください。その後、注文で Omise: Sync payment status を実行します。Webhook の応答を確認するには、Debug log を有効にしてください。
Webhook が Earlier charge of the order, order not changed を返す:このイベントは、再試行によって置き換えられた注文の以前の試行に関するものです。注文は変更されません。その以前の課金が Omise でまだ支払い済みまたは承認済みの場合、注文メモに 1 回だけ通知されます。Omise ダッシュボードで二重払いがないか確認し、そちらで返金または取り消しを行ってください。
Webhook が Charge ID does not match order を返す:イベントの課金は別の注文に属しています。何も変更されません。
Webhook が Order is being processed, retry later または Failed to verify charge を返す:注文が別のリクエストによってロックされていたか、Omise API に接続できませんでした。Omise は Webhook を再試行します。
保存時のエラー:key must start with ... または must be a live key:誤った欄にキーが貼り付けられています。テストキーは pkey_test_ / skey_test_ で、本番キーは pkey_ / skey_ で始まります。
購入者に Card payments are temporarily unavailable と表示される:キーが正しくないか、カードトークンが別のモードのものです(本番モードでテストトークンを使用した場合、またはその逆)。キーと Test mode を確認してください。
購入者に We could not reach the payment provider と表示される:課金の作成時に、Omise から有効な応答が返ってきませんでした。課金が作成されている可能性があります。注文メモには、注文に再度請求する前に Omise ダッシュボードを確認するよう書かれています。
購入者に This order is already being paid と表示される:チェックアウトが同時に 2 回送信されました。購入者は待ってからメールを確認し、再度試してください。
支払い後に注文が保留になる:注文メモを確認してください。注文はキャプチャを待っているか、Omise がまだ支払いを確認していないか、金額または通貨が注文と異なっています。
モードに関するメッセージで返金が失敗する:支払いはテストモードまたは本番モードで行われましたが、そのモードの秘密キーが設定されていません。キーを入力して、もう一度試してください。
承認済み注文の部分返金が失敗する:支払いは承認のみの状態です。先にキャプチャするか、全額を返金して取り消してください。
ライセンスブロックにエラーが表示される:ブロックのメッセージに従ってください。例えば、キーが別のドメインで既に使用されている場合は、vibefox.net のアカウントで枠を解放し、Check now をクリックします。サイトのアドレスが変更された場合は、Check now をクリックして、新しいドメインでキーを有効化します。ライセンスサーバーに接続できない場合、プラグインは最後に確認されたステータスで動作を続けます。
アンインストール
プラグインを無効化してもすべてのデータは保持されます。削除するには、Plugins ページでプラグインを無効化してから削除します。このプラグインのライセンスキーとライセンスステータスは常に削除されます。ゲートウェイの設定とログは、Delete data on uninstall がオンの場合にのみ削除されます。それ以外の場合は、後日再インストールするために残ります。注文に保存された Omise のデータは支払い履歴であり、常に保持されます。既存の注文は、支払いメモとトランザクション ID を保持します。
Omise は各所有者の商標です。本プラグインは Omise と提携しておらず、Omise による承認も受けていません。
