VibeFox Tap for WooCommerce — ヘルプ

要件

WordPress: 6.0 以降。

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

PHP: 8.0 以降。

ストア通貨: AED、BHD、EGP、EUR、GBP、JOD、KWD、OMR、QAR、SAR、USD のいずれか。それ以外の通貨では、チェックアウト時に決済方法が表示されません。

サイトのインターネット接続: Tap は決済結果をストアのウェブフックに送信するため、サイトがインターネットから到達可能である必要があります。ウェブフック URL はすべての決済とともに送信されます。Tap のダッシュボードで設定する必要はありません。

Tap アカウント: Tap ダッシュボード（goSell、API 認証情報）の API キーが必要です。テストキーは pk_test_ / sk_test_、本番キーは pk_live_ / sk_live_ で始まります。シークレットキーは常に必要です。公開可能キーはチェックアウトポップアップの場合のみ必要です。提供される決済方法（mada、KNET、Benefit など）や Apple Pay のドメイン確認は、Tap アカウントで設定します。

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

インストール

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

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

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

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

5. Tap のテストキーと本番キーを入力し、決済のアクション、チェックアウトの方式、Tap ページの言語を選択します（設定の項を参照）。

6. Enable / Disable をオンにして保存します。Tap のテストカードで確認してから、Test mode のチェックを外します。

設定

すべての設定は 1 つのページにあります: WooCommerce > Settings > Payments > Tap Payments。テストモードがオンの間、フィールドの上に Test mode is on: payments use your Tap test keys and no real money is charged. と表示されます。現在のモードのキーがない場合（この場合、チェックアウトにゲートウェイは表示されません）や、ストア通貨が Tap で提供されていない場合も、そのことが表示されます。決済方法の一覧では、現在のモードにシークレットキー（ポップアップの場合は公開可能キーも）が設定されるまで、Tap Payments に設定が必要と表示されます。

保存時に、フィールドに対して接頭辞が誤っているキーは保存されません。エラーが表示され、以前の値が保持されます。例えば、テスト用フィールドに本番キーを入力すると拒否されます。

全般

Enable / Disable: Enable Tap Payments で決済方法を有効または無効にします。初期値: オフ。

Title: チェックアウトに表示される決済方法の名前。初期値: Tap Payments。

Description: チェックアウトで決済方法の下に表示されるテキスト。初期値: Pay with Visa, Mastercard, mada, KNET, Benefit, Apple Pay or Google Pay。

Tap API キー

キーは Tap ダッシュボード（goSell、API 認証情報）で確認できます。テストキーは pk_test_ / sk_test_、本番キーは pk_live_ / sk_live_ で始まります。

Test mode: Use the test keys (no real money is charged)。決済、ステータス確認、返金は、常に決済が行われたモードのキーを使用します。そのため、本番に切り替えた後も、テスト決済はテストキーで確認・返金されます。初期値: オン。

Test publishable key: pk_test_ で始まります。ポップアップに必要です。

Test secret key: sk_test_ で始まります。

Live publishable key: pk_live_ で始まります。ポップアップに必要です。

Live secret key: sk_live_ で始まります。

Merchant ID: 任意。Tap の加盟店 ID です。Tap から特定の加盟店アカウントへ決済を振り分けるよう求められた場合にのみ必要です。

決済

Payment action: 購入者が支払ったときに、資金がどう扱われるか。

Checkout type: 購入者が支払う場所。

Tap page language: English（初期値）または Arabic。

決済通知（ウェブフック）

Tap は、このセクションに表示される URL に決済結果を送信します。URL の形式は https://your-site/wc-api/tap_p_webhook/ です。URL はすべての決済とともに送信されるため、Tap のダッシュボードで設定する必要はありません。インターネットから到達可能であること（ファイアウォール、メンテナンスモード、HTTP 認証によってブロックされていないこと）だけ確認してください。各通知は hashstring 署名（決済のモードのシークレットキーを使用する HMAC-SHA256）で検証されます。有効な署名のないウェブフックは拒否されます。署名された通知であっても、それだけで信頼されるわけではありません。プラグインは注文を変更する前に、Tap API から決済を再度読み取ります。ウェブフックが機能していない場合、注文は購入者が支払い後にストアに戻ったときにのみ更新されます。

詳細設定

Debug log: Log payment events (WooCommerce → Status → Logs, source "wcp_tap_payment_gateway")。エラーは常に記録されます。ログにキー、カード情報、購入者データが含まれることはありません。初期値: オフ。

Delete data on uninstall: Delete the gateway settings and logs when the plugin is deleted (order payment records are kept)。初期値: オフ。

チェックアウト

購入者は決済方法（初期値は Tap Payments）を選び、注文します。テストモードでは、チェックアウトに Test mode: no real payment will be made. と表示されます。

Tap payment page: プラグインは、注文通貨での注文合計に対して Tap の請求（Authorize only モードでは承認）を作成し、説明に Order # と注文番号を設定して、購入者を Tap の決済ページに移動させます。そこで購入者はカード、mada、KNET、Benefit、Apple Pay、Google Pay（Tap アカウントで有効になっているもの）から選んで支払います。Tap が決済を開始できない場合、購入者には The Tap payment could not be started. Please try again or choose another payment method. が表示され、その理由が注文メモに記録されます。

Tap checkout popup: 購入者は注文の支払いページに移動し、そこで Tap の決済フォームが開きます。このページには Pay on the Tap payment page instead のリンクも表示されます。ウィンドウを閉じた場合、Pay now ボタンで再度開けます。フォームを読み込めない場合は、購入者に Tap の決済ページを使うよう案内されます。

決済後、購入者は注文受付ページに戻ります。注文が支払い済みになるのは、Tap が確認した後だけです。プラグインは決済のモードのキーを使って Tap API から決済を読み取り、その決済がこの注文に関するものであり、この注文のチェックアウトから開始されたことを確認します。そして金額と通貨を注文と照合します。戻りアドレスに含まれる Tap ID だけで注文が支払い済みになることはありません。ウェブフックは、バックグラウンドで同じ確認を行います。繰り返されるウェブフックや戻りによって、注文が二重に変更されることはありません（注文ごとに同時に変更されるのは 1 つだけです）。

決済がまだ確認されていない場合、注文受付ページには We have not received the payment confirmation from Tap yet. If you completed the payment, the order will be updated automatically in a few minutes — there is no need to pay again. と表示されます。承認済みの決済の場合は Your payment has been authorized. We will process the order as soon as the payment is captured. と表示されます。

決済が拒否されたか、中断された場合、注文は失敗としてマークされ、購入者は Pay for order ページに戻ります。そこには Your payment was not completed. Please try again or choose another payment method. と表示されます（Tap が理由を示した場合は、その理由も表示されます）。未完了の決済には The payment was not completed. You can try again below. と表示されます。購入者は、そのページから注文を再度支払うことができます。

この決済方法は、クラシックチェックアウト、チェックアウトブロック、Pay for order ページで機能します。WooCommerce High-Performance Order Storage（HPOS）に対応しています。

本プラグインには、カードの保存やトークン化、サブスクリプション、チェックアウトページに組み込まれたカード入力欄はありません。Capture Tap payment は常に注文合計をキャプチャします。部分キャプチャには対応していません。

注文と返金

注文ステータス

Pending payment: 購入者が Tap に移動されたものの、まだ支払っていない、または Tap がまだ決済を確認していない状態です。

Processing: Tap が、キャプチャ済みの決済を確認した状態です。これは支払い後の WooCommerce の標準ステータスです（ダウンロード可能な仮想商品のみの注文は、直接「完了」になります）。注文メモには、金額、Tap の請求 ID（chg_...）、決済方法、そして（テストモードの場合）テスト決済であることが表示されます。取引 ID は Tap の請求 ID です。

On hold: 決済は承認されただけで、キャプチャを待っています。または、支払われた金額や通貨が注文と一致しませんでした（Tap: amount/currency mismatch — manual review required.）。または、注文のキャンセル後に決済が届きました。理由は注文メモに記載されます。

Failed: 決済が拒否された、中断された、キャンセルされた、またはタイムアウトになりました。まだ支払いを待っている注文だけが失敗としてマークされます。失敗した試行が、支払い済み、承認済み、キャンセル済みの注文を変更することはありません。購入者は再度支払うことができます。

Cancelled: Void Tap authorization で承認が取り消され、押さえられていた資金が解放されました。

既に支払い済みの注文に対して 2 件目の決済が成功した場合、その注文は再度変更されません。メモには、これが重複決済であることが表示され、Tap ダッシュボードで返金するよう求められます。注文に関連するものの、その注文のチェックアウトから開始されなかった決済は、記録されるだけです。

キャプチャと取り消し

Authorize only モードでは、保留中の注文を開き、Order actions で次のいずれかを選びます: Capture Tap payment は注文合計をキャプチャし、その後、注文は支払い済みになります。Void Tap authorization は資金を解放し、注文をキャンセルします。Tap がこの操作を拒否した場合、エラーが表示され、注文メモに追加されます。承認が Tap ダッシュボードで直接キャプチャされた場合、ウェブフックは注文を支払い済みにします。この種の決済の返金は Tap ダッシュボードで行う必要があります。

返金

注文を開き、Refund をクリックして金額を入力し、Refund via Tap Payments をクリックします（ボタンには Title の設定値が表示されます）。キャプチャ済みの Tap 請求に対して、全額返金と一部返金に対応しています。返金は決済が行われたモードのシークレットキーで送信されるため、そのモードのキーが設定されている必要があります。Tap が承認した返金は、Tap の返金 ID とステータスとともに注文メモに追加されます。Tap が拒否した場合、WooCommerce にエラーが表示され、返金は記録されません。Tap ダッシュボードで行った返金は、WooCommerce には表示されません。

ライセンスキー

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

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

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

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

トラブルシューティング

Tap Payments がチェックアウトに表示されない: ライセンスが有効であること、Enable / Disable がオンであること、現在のモードにシークレットキーがあること（Checkout type がポップアップの場合は公開可能キーも）を確認してください。ストア通貨（または Pay for order ページの注文通貨）が、AED、BHD、EGP、EUR、GBP、JOD、KWD、OMR、QAR、SAR、USD のいずれかであることを確認してください。設定ページには、これらの問題ごとに通知が表示されます。

決済は完了したが、注文が Pending payment のまま: ウェブフックがサイトに到達できていません。設定に表示されている URL（/wc-api/tap_p_webhook/）がインターネットから到達可能であること（ファイアウォール、メンテナンスモード、HTTP 認証がないこと）を確認し、WooCommerce > Status > Logs のソース wcp_tap_payment_gateway を確認してください。購入者が Tap から戻ったときにも、注文は更新されます。

Webhook answers invalid signature: 通知は、決済のモードのシークレットキーで署名されていません。設定のシークレットキーを確認してください。

Webhook answers gateway not configured: 決済のモード（テストまたは本番）のシークレットキーが空です。入力してください。

Webhook answers verification failed: 決済を確認するために Tap API に接続できませんでした。Tap は後でウェブフックを再試行します。

キーが保存されない: キーは、そのフィールドの接頭辞で始まる必要があります: pk_test_、sk_test_、pk_live_、sk_live_。

注文が On hold: 注文メモを確認してください。決済は承認のみされています（注文操作からキャプチャしてください）。支払われた金額や通貨が注文と一致しなかったか、注文のキャンセル後に決済が届きました。

モードに関するメッセージで返金が失敗する: 決済はテストモードまたは本番モードで行われましたが、そのモードのシークレットキーが設定されていません。入力してから、もう一度お試しください。メモに、キャプチャ済みの Tap 請求が見つからなかったと書かれている場合は、Tap ダッシュボードで返金してください。

開発者フック: フィルター tap_p_supported_currencies、tap_p_currency_decimals、tap_p_charge_payload、tap_p_icon、tap_p_checkout_sdk_url、tap_p_payment_page_hosts を利用できます。

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

アンインストール

プラグインを無効化しても、すべてのデータは保持されます。削除するには、無効化してから Plugins ページで削除します。このプラグインのライセンスキーとライセンスステータスは、常に削除されます。ゲートウェイの設定、プラグインのその他のオプション、ログは、Delete data on uninstall がオンになっている場合にのみ削除されます。そうでない場合は、後日の再インストールのために残ります。既存の注文は、決済のメモ、Tap ID、取引 ID を保持します。

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