VibeFox Paymob for WooCommerce — ヘルプ

動作要件

WordPress：6.2 以降。

WooCommerce：8.0 以降。インストールされ、有効化されている必要があります。WooCommerce がないとプラグインは有効化できません。

PHP：8.0 以降。

Paymob アカウント：対応国（エジプト、アラブ首長国連邦、サウジアラビア、オマーン、パキスタン）のいずれかの加盟店アカウント。Paymob のダッシュボードから、API キー、オンライン決済連携の連携 ID、決済ページの iFrame ID、HMAC シークレットの 4 つの値が必要です。

通貨：ストアの通貨は、Paymob 対象国の通貨である必要があります。エジプトは EGP、アラブ首長国連邦は AED、サウジアラビアは SAR、オマーンは OMR、パキスタンは PKR です。別の通貨の場合、チェックアウトでこの支払い方法は表示されません。

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

インストール

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

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

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

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

5. Paymob country を選択し、API キー、連携 ID、iFrame ID、HMAC シークレットを入力します（設定を参照）。

6. Paymob のダッシュボードで、連携のコールバック URL を設定ページに表示されている URL に設定します（Callbacks を参照）。

7. Enable/Disable をオンにします。Paymob のテスト連携の ID で決済をテストし、その後、本番連携の ID を入力します。

設定

すべての設定は 1 つのページにあります：WooCommerce > Settings > Payments > Paymob。入力欄の上には、Paymob の 4 つの値のいずれかが未入力の場合（それまでチェックアウトに Paymob は表示されません）や、ストアの通貨が選択した Paymob 対象国で受け付けられない場合に警告が表示されます。ボックスには、Copy ボタン付きのコールバック URL と、選択した国の Paymob ダッシュボードへのリンクが表示されます。

一般

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

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

Description：チェックアウトで支払い方法の下に表示されるテキストです。デフォルト：Pay securely by card or mobile wallet on the Paymob payment page.

Paymob アカウント

すべての値は Paymob の加盟店ダッシュボードにあります。個別のテストモードはありません。テスト決済には、テストモードの連携の連携 ID を入力してください。その他の設定は変更されません。

Paymob country：Paymob アカウントの国です。API および決済ページのサーバーが決まり、ストアの通貨はこの国の通貨である必要があります。デフォルト：Egypt。

API key：Paymob のダッシュボードの Settings > Account info > API Key にあります。

Integration ID：Paymob のダッシュボードの Developers > Payment Integrations にある、オンラインのカードまたはウォレット連携の数値 ID です。Paymob の決済ページに表示される支払い方法は、この連携のものです。

iFrame ID：Paymob のダッシュボードの Developers > iframes にある、決済 iFrame の数値 ID です。

HMAC secret：Paymob のダッシュボードの Settings > Account info > HMAC にあります。必須です。注文は、このシークレットで署名されたコールバックによってのみ支払い済みになります。

Integration ID と iFrame ID は数字のみを含める必要があります。スペースは削除されます。それ以外の値は保存時に拒否され、フィールドには must contain digits only — the previous value was kept と表示されます。

Callbacks

Paymob は、各取引をお店に通知します。Paymob のダッシュボードで Developers > Payment Integrations を開き、連携を選んで Edit をクリックし、Transaction processed callback と Transaction response callback の両方に、設定ページに表示されている URL を設定します。URL は https://your-site/wc-api/paymob_pay/ のような形式です。Copy ボタンでコピーしてください。テスト連携を含め、使用するすべての連携に URL を設定してください。

処理済み取引のコールバックは Paymob のサーバーから送信されます。取引応答のコールバックは、購入者をお店に戻します。どちらも HMAC シークレットで署名され、プラグインによって検証されます。有効な署名のないコールバックは拒否され、何も変更しません。サーバーからのコールバックが遅れたり失われたりした場合は、署名付きの購入者の戻りによっても支払いが確認されます。

詳細設定

Debug log：Log payment steps and callbacks を有効にすると、支払いの手順とコールバックが WooCommerce > Status > Logs に、ソース wcp_paymob_pay として書き込まれます。エラーと拒否されたコールバックは常に記録されます。キー、トークン、顧客データは書き込まれません。デフォルト：オフ。

Clean uninstall：Delete the plugin settings and logs when the plugin is deleted。プラグインを無効化しても、何も削除されません。注文に保存された Paymob の ID は保持されます。デフォルト：オフ。

チェックアウト

購入者は支払い方法（デフォルトは Paymob）を選び、注文を確定します。プラグインは、注文通貨での注文合計額に対して新しい Paymob 注文を作成し、購入者の氏名、メールアドレス、電話番号、請求先住所を Paymob に渡して、お住まいの国の Paymob 決済ページに購入者を移動させます。そこで購入者は、カードやモバイルウォレットなど、連携で利用可能な方法のいずれかで支払います。

支払い後、購入者はお店に戻ります。注文は、Paymob が署名付きの取引で確認した後にのみ、支払い済みになります。支払い済み、保留中、または承認済みの支払いの場合、購入者は注文受付ページに移動します。

支払いが拒否された場合、購入者は次のメッセージとともにチェックアウト（支払いが Pay for order ページで開始された場合は同ページ）に戻ります：Your Paymob payment was not completed. Please try again or choose another payment method. 再試行のたびに新しい Paymob 注文が作成されるため、購入者は同じ注文を再度支払うことができます。Paymob からの戻りを検証できない場合、購入者には We could not verify the response from Paymob. If you were charged, your order will be updated as soon as Paymob confirms the payment. と表示されます。

Paymob が支払いを開始できない場合、購入者には短いメッセージが表示され、別の支払い方法を選べます。たとえば Paymob could not start the payment. Please check your billing details and try again, or choose another payment method. や Could not connect to Paymob. Please try again in a moment. などです。技術的な理由はログに書き込まれます。

この支払い方法は、クラシックチェックアウト、チェックアウトブロック、Pay for order ページで動作します。Pay for order ページでは、ストアの通貨ではなく注文の通貨が確認されます。WooCommerce の高性能注文保存（HPOS）に対応しています。

プラグインは、Paymob のページでの一回払いのみを扱います。保存済みカード、定期購入、サイト上の埋め込みカードフォーム、WooCommerce からの返金には対応していません。

注文

注文ステータス

Pending payment：購入者は Paymob に移動したものの、まだ支払っていないか、Paymob がまだ支払いを確認していません。

Processing：Paymob が支払いを確認しました。ダウンロード可能なバーチャル商品のみの注文は、WooCommerce の標準である完了ステータスに移行します。注文メモには、Paymob の取引、金額、カードの種類と下 4 桁が表示されます。取引 ID は Paymob の取引 ID です。

On hold：Paymob で支払いが保留中です（例：現金払いやキオスク払い）。または、Paymob は金額を承認したもののキャプチャしていません（Paymob のダッシュボードでキャプチャしてください。キャプチャのコールバックが届くと注文は完了します）。または、支払われた金額または通貨が注文と異なります。または、キャンセルされた注文に対して支払いが届きました。理由は注文メモに記載されます。

Failed：Paymob が保留中の注文の支払いを拒否しました。購入者は再度支払うことができます。

すでに支払い済みの注文に対して 2 回目の支払いが成功して届いた場合、注文は変更されません。メモには、Paymob のダッシュボードで重複分を返金するよう記載されます。以前に支払い済みだったキャンセル済みの注文や、返金済みの注文に対する支払いは、メモが追加されるだけで、注文は再開されません。

返金

WooCommerce からの返金には対応していません。Paymob のダッシュボードで支払いを返金またはキャンセルしてください。Paymob が返金またはキャンセルを報告すると、注文にメモが追加されますが、注文ステータスは変更されません。たとえば WooCommerce で手動返金を行うなど、注文を手動で更新してください。

ライセンスキー

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

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

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

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

トラブルシューティング

チェックアウトに Paymob が表示されない：ライセンスが有効であること、Enable/Disable がオンであること、4 つの値（API key、Integration ID、iFrame ID、HMAC secret）がすべて入力されていること、ストアの通貨が選択した Paymob country の通貨であることを確認してください。設定ページには、不足しているものがあると警告が表示されます。複数通貨の Paymob アカウントを使用する開発者は、paymob_p_supported_currencies フィルターで受け付ける通貨を追加できます。

支払いは完了したが、注文が Pending payment のまま：コールバックがお店に届いていません。使用中の連携の Transaction processed callback と Transaction response callback が、設定ページに表示されている URL と完全に一致していること、そして HMAC secret が同じ Paymob アカウントのものであることを確認してください。拒否されたコールバックは、デバッグログがオフでも、WooCommerce > Status > Logs にソース wcp_paymob_pay の警告として記録されます。

コールバックが Invalid signature と応答する：設定の HMAC シークレットが Paymob アカウントと一致しないか、別の国のアカウントが選択されています。HMAC シークレットをコピーし直してください。

コールバックが Not configured と応答する：HMAC シークレットが空です。シークレットを入力してください。Paymob はコールバックを再送します。

コールバックが locked と応答する：購入者の戻りなど、別のリクエストが同時に注文を更新していました。Paymob はコールバックを再送します。

注文時に購入者にエラーが表示される：Debug log をオンにして、ログを確認してください。Paymob payments are temporarily unavailable は、API キーが誤っているか、値が不足していることを意味します。Paymob could not start the payment は、連携 ID が誤っているか請求情報が不完全であるなどの理由で、Paymob がリクエストを拒否したことを意味します。This order cannot be paid with Paymob は、注文合計が 0 であることを意味します。

支払い後に注文が On hold になる：注文メモを確認してください。支払いが保留中（現金またはキオスク）である、取引が承認のみでキャプチャされていない（Paymob のダッシュボードでキャプチャしてください）、金額または通貨が一致しなかった、または注文がキャンセルされた後に支払いが届いた、のいずれかです。理由は注文メモに記載されます。

テスト決済：Paymob のテスト連携の ID を Integration ID に入力し、その連携でコールバック URL を設定してください。実際の決済では、本番連携の ID を再度入力してください。

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

アンインストール

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

Paymob は、各所有者の商標です。本プラグインは Paymob とは提携しておらず、Paymob による推奨も受けていません。