VibeFox Wompi for WooCommerce — ヘルプ

要件

WordPress: 5.8 以降。

WooCommerce: 7.0 以降。インストールされ、有効になっている必要があります。WooCommerce がない場合、プラグインは有効化できません。

PHP: 8.0 以降。

ストアの通貨: コロンビア・ペソ（COP）。Wompi Colombia は COP で請求するため、他の通貨の注文では支払い方法が非表示になります。

Wompi アカウント: Wompi Colombia の加盟店アカウント。各環境（サンドボックスと本番）には 4 つのキーがあります: 公開キー、秘密キー、イベントシークレット、整合性シークレット。これらは Wompi の加盟店管理画面（comercios.wompi.co）の開発者セクションにあります。Wompi El Salvador と Panama は別の API を使用するため、対応していません。

VibeFox ライセンスキー: vibefox.net で購入します。1 つのキーは 1 つのドメインで使用できます。

インストール

1. WordPress で Plugins > Add New > Upload Plugin に移動し、プラグインの ZIP ファイルを選択して Install Now をクリックします。FTP で wcp_wompi_payment フォルダを /wp-content/plugins/ にアップロードすることもできます。

2. Activate をクリックします。

3. WooCommerce > Settings > General で、ストアの通貨をコロンビア・ペソ（COP）に設定します。

4. 設定を開きます: WooCommerce > Settings > Payments > Wompi。または、プラグインのページでプラグイン名の下にある Settings をクリックします。

5. ページ上部のライセンスブロックに VibeFox ライセンスキーを入力し、Activate をクリックします。

6. Wompi の加盟店管理画面からサンドボックスと本番のキーを貼り付け、Wompi で Events URL を設定します（設定の項を参照してください）。

7. Enable/Disable をオンにします。サンドボックスモードで支払いをテストしてから、Sandbox mode のチェックを外すと、実際の支払いを受け付けられます。

設定

すべての設定は 1 つのページにあります: WooCommerce > Settings > Payments > Wompi。フィールドの上のステータスボックスには、現在のモードである SANDBOX または PRODUCTION が表示されます。このモードのキーが不足している場合、ボックスには不足しているキーが表示され、この環境のすべてのキーが設定されるまで、支払い方法がチェックアウトで非表示になることが示されます。すべてのキーが設定されると、実際の支払いが請求されるかどうかが示されます。保存時には、キーがそのセクションの接頭辞で始まっていない場合や、Wompi が有効なのにキーが不足しているためチェックアウトで非表示になっている場合に、プラグインが警告します。支払い方法の一覧では、現在のモードに 4 つのキーがすべて揃うまで、Wompi は設定が必要な状態として表示されます。バージョン 1.0 のキーは、更新時に対応する Sandbox または Production セクションへ自動的に移動されます。

一般

Enable/Disable: Enable Wompi で支払い方法のオン・オフを切り替えます。デフォルト: オフ。

Title: チェックアウトで購入者に表示される支払い方法の名前。デフォルト: Wompi。

Description: チェックアウトで支払い方法の下に表示されるテキスト。デフォルト: Pay securely with Wompi: cards, PSE, Nequi, Bancolombia and more.

Wompi アカウント

Wompi の加盟店管理画面（comercios.wompi.co）の開発者セクションからキーをコピーします。各環境には、それぞれ独自の公開キー、秘密キー、イベントシークレット、整合性シークレットがあります。

Sandbox mode: Use the Wompi sandbox (sandbox keys, no real money)。キーと Wompi API（sandbox.wompi.co または production.wompi.co）の両方を切り替えます。注文は支払いが行われた環境を保持します。デフォルト: オン。実際の支払いを受け付けるには、チェックを外します。

サンドボックスのキー

Wompi サンドボックスの 4 つのキーです。それぞれ pub_test_、prv_test_、test_events_、test_integrity_ で始まります。

Public key: サンドボックスの公開キー（pub_test_...）。Wompi Web Checkout でお客様のアカウントを識別します。

Private key: サンドボックスの秘密キー（prv_test_...）。Wompi API からトランザクションを読み取るために使用します。

Events secret: サンドボックスのイベントシークレット（test_events_...）。Wompi イベントの署名を検証します。

Integrity secret: サンドボックスの整合性シークレット（test_integrity_...）。Web Checkout に送信される支払いリクエストに署名します。

本番のキー

Wompi 本番環境の 4 つのキーです。それぞれ pub_prod_、prv_prod_、prod_events_、prod_integrity_ で始まります。

Public key: 本番の公開キー（pub_prod_...）。

Private key: 本番の秘密キー（prv_prod_...）。

Events secret: 本番のイベントシークレット（prod_events_...）。

Integrity secret: 本番の整合性シークレット（prod_integrity_...）。

Events URL（webhook）

Wompi のイベントは、トランザクションが変更されたことをストアに通知します。Wompi の加盟店管理画面の開発者セクションで、この設定セクションに表示される Events URL を、サンドボックスと本番の両方に設定します。形式は https://your-site/wc-api/wompi_p/ のようになります。URL は設定に表示されているとおりに、そのままコピーしてください。

プラグインは次のイベントを使用します:

その他のイベントには Ignored が返されます。各イベントは、その環境（サンドボックスまたは本番）のイベントシークレットで検証されます。有効な署名がないイベントは拒否されます。検証後、トランザクションは Wompi API から読み取られ、そのデータのみが使用されます。Events URL が設定されていない場合、注文は購入者が支払い後にストアに戻ったときにのみ確定します。

詳細設定

Debug log: Log payment and webhook activity は、支払いとイベントのアクティビティを WooCommerce > Status > Logs（ソース: wcp_wompi_payment）に書き込みます。このオプションがオフでも、エラーは常に記録されます。キー、シークレット、購入者データは記録されません。デフォルト: オフ。

Delete data on uninstall: Remove the plugin settings and logs when the plugin is deleted。無効化しても何も削除されません。注文データは常に保持されます。デフォルト: オフ。

チェックアウト

購入者は支払い方法（デフォルトは Wompi）を選択し、注文します。サンドボックスモードでは、説明の下に Sandbox mode: no real payment is made. と表示されます。プラグインは、独自の参照番号（WC-、注文番号、タイムスタンプ）を持つ支払い試行を作成し、整合性シークレットで署名して、COP 建ての注文合計とともに購入者を Wompi Web Checkout に送ります。購入者の請求先メールアドレスと氏名は Wompi に渡されます。注文のメモには、環境、参照番号、金額が記録されます。

Wompi のページで、購入者は Wompi アカウントで有効になっている任意の支払い方法で支払います。その後、Wompi は購入者をストアの注文受付ページに戻します。注文が支払い済みになるのは、Wompi が確認した後だけです。署名付きイベント、または購入者がそのページに到達したときにサーバーから Wompi API へ送られるリクエストによって確認されます。戻り先アドレス内のトランザクション番号は信頼されません。ページを再読み込みした場合、トランザクションは最大で 20 秒に 1 回再確認されます。

その注文を支払えるのは、その注文のために作成されたトランザクションだけで、しかも支払い試行と同じ環境のものに限られます。購入者は、未払いの注文を、たとえば Pay for order ページから再度支払うことができます。試行のたびに新しい参照番号が割り当てられます。

支払い方法が表示されるのは、ライセンスが有効で、現在のモードの 4 つのキーがすべて設定され、注文の通貨が COP で、合計が COP 1,500 以上の場合だけです。支払いを開始できない場合、購入者には短いメッセージが表示され、別の支払い方法を選べます:

支払い方法は、クラシックチェックアウト、チェックアウトブロック、Pay for order ページで動作します。WooCommerce High-Performance Order Storage（HPOS）に対応しています。コロンビアとスペイン向けのスペイン語翻訳が含まれています。

プラグインは WooCommerce から返金しません。貴サイトには保存済みカード、サブスクリプション、カード入力欄はありません。すべての支払いデータは Wompi で入力されます。

注文

注文ステータス

Pending payment: 購入者は Wompi に送られたものの、まだ支払っていないか、Wompi がまだトランザクションを確認していません。

On hold (pending payment): Wompi がトランザクションを保留中として報告しています。たとえば、確認を待っている PSE、Nequi、現金払いの支払いです。注文は、Wompi が承認または拒否するまで保留のままです。

Processing or Completed: トランザクションが承認されました。WooCommerce の標準が適用されます。処理中、または注文が仮想のダウンロード可能な商品のみの場合は完了です。注文のメモには、Wompi のトランザクション、支払い方法の種類（例: カード、PSE、Nequi）、参照番号が表示されます。注文のトランザクション ID は、Wompi のトランザクション ID です。

On hold after payment: Wompi が、注文合計と異なる金額または通貨を承認しました（たとえば、支払いの開始後に注文が編集された場合）。または、注文がキャンセルされた後に支払いが承認されました。注文は支払い済みにはなりません。注文のメモに理由が記載されます。Wompi の管理画面で支払いを確認し、注文を処理するか、支払いを返金してください。

Failed: 最新の支払い試行のトランザクションが拒否されたか、エラーで終了しました。Wompi のメッセージがメモに追加されます。以前の試行の結果は注文を変更しません。

Cancelled: 注文が支払われる前に、最新の支払い試行のトランザクションが Wompi で取り消されました。

既に支払い済みの注文に対して 2 回目の承認済み支払いが届いた場合、注文は変更されません。メモで、Wompi の管理画面から重複分を返金するよう求められます。支払いのトランザクションが Wompi で取り消された場合、メモで注文の確認が求められます。返金済みの注文に対する遅れた支払いは、メモを追加するだけです。繰り返されるイベントや購入者の戻りによって、メモ、メール、在庫変更が重複することはありません。

返金

返金は WooCommerce から送信されません。Wompi の加盟店管理画面で支払いを返金または取り消してから、WooCommerce で手動返金を記録してください。Wompi で行われた取り消しは、注文にメモとして追加されます。

ライセンスキー

本プラグインは、vibefox.net で取得した VibeFox ライセンスキーで動作します。ライセンスブロックは WooCommerce > Settings > Payments > Wompi の上部にあります。キーを License key に貼り付け、Activate をクリックします。ブロックには、ライセンスが有効な期限日やお客様のドメインなどのステータスが表示されます。Check now を使うとステータスを再確認でき、Change key で別のキーを入力でき、Remove key でこのサイトからキーを削除できます。Manage licenses and domains in your account のリンクからは、vibefox.net のアカウントが開きます。

1 つのキーは 1 つのドメインでのみ使用できます。サイトからキーを削除しても、そのドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。

有効なキーがない場合、Wompi はチェックアウトで購入者に表示されません。それでも支払いが開始された場合、購入者には This payment method is not available. Please choose another one. と表示されます。ログイン中のストア管理者には、(unlicensed — visible to admins only) と表示された状態で支払い方法が引き続き表示されるため、キーを購入する前にプラグインを設定してテストできます。プラグインページと WooCommerce のページには通知が表示されます。既存の注文には影響しません。すでに開始された支払いは、引き続き Wompi のイベントと購入者の戻りによって確認されます。

ライセンスの期限が切れても、プラグインは動作を続けますが、更新とサポートには更新手続きが必要です。ステータスは、バックグラウンドで自動的に再確認されます。

トラブルシューティング

Wompi がチェックアウトに表示されない: ライセンスが有効であること、Enable/Disable がオンであること、現在のモードの 4 つのキーがすべて設定されていることを確認してください（設定ページのステータスボックスに不足しているキーが表示されます）。また、注文の通貨が COP であり、注文合計が COP 1,500 以上であることも確認してください。

支払いは完了したが、注文が Pending payment のまま: Events URL が機能していません。Wompi の管理画面で、使用している環境（サンドボックスまたは本番）の Events URL が設定されていて、設定に表示されているものと完全に一致することを確認してください。また、その環境のイベントシークレットが対応するセクションにあることを確認してください。購入者が支払い後にストアへ戻った場合にも、注文は確定します。

Events URL が Not configured を返す: イベントの環境のイベントシークレットが空です。設定に貼り付けてください。

Events URL が Invalid signature を返す: イベントシークレットが別の環境または別のアカウントのものです。Wompi の管理画面から再度コピーしてください。

Events URL が Transaction lookup failed を返す: Wompi API がトランザクションを返しませんでした。秘密キーの誤りやネットワークの問題などが原因として考えられます。Wompi は後でイベントを再送します。

Events URL が Busy, retry を返す: 同じタイミングで別のリクエストによって注文が更新されていました。Wompi は後でイベントを再送します。

Events URL が Environment mismatch を返す: サンドボックスのトランザクションが本番の支払い試行に届いた、またはその逆です。サンドボックスの支払いが本番の注文を確定させることはありません。

保存時の "The key does not start with ..." 警告: キーが誤ったセクションに貼り付けられています。サンドボックスのキーは pub_test_、prv_test_、test_events_、test_integrity_ で始まり、本番のキーは pub_prod_、prv_prod_、prod_events_、prod_integrity_ で始まります。

注文が On hold になり、金額に関するメモがある: 承認された金額または通貨が注文合計と異なります。Wompi の管理画面で支払いを確認し、注文を手動で完了するか返金してください。

その他のエラー: 注文のメモ、または WooCommerce > Status > Logs（ソース: wcp_wompi_payment）を開いてください。エラーは常に記録されます。詳細を確認するには Debug log をオンにしてください。開発者は、Wompi アカウントが対応していれば、wompi_p_supported_currencies フィルターで別の通貨を許可できます。

ライセンスブロックにエラーが表示される: ブロック内のメッセージに従ってください。たとえば、キーが別のドメインで既に使用されている場合は、vibefox.net のアカウントで枠を解放し、Check now をクリックしてください。サイトのアドレスが変わった場合は、Check now をクリックして、新しいドメインでキーを有効にしてください。ライセンスサーバーに接続できない場合、プラグインは最後に確認できたステータスで動作を続けます。

アンインストール

プラグインを無効化しても、すべてのデータは保持されます。削除するには、Plugins ページで無効化してから削除してください。このプラグインのライセンスキーとライセンスステータスは、常に削除されます。ゲートウェイの設定とプラグインのログは、Delete data on uninstall がオンの場合にのみ削除されます。それ以外の場合は、後で再インストールする際のために残ります。既存の注文は、支払いのメモ、Wompi のデータ、トランザクション ID を保持します。

Wompi は、それぞれの所有者の商標です。本プラグインは Wompi と提携しておらず、Wompi による承認も受けていません。